API Guide

The type of SFD data being backed up.
size integer
The size of this backup le in KB.
backup_time integer
Time at which the backup was taken. The timestamp is dened in epoch milliseconds.
version string
Version of SFD. This eld is needed for getting restore status. It is not needed when retrieving
backups.
}
restore_info {
Information about the restore result. It will be shown in restore detail page once restore is completed.
content [enum] ALLOWED:CONFIG_DATA, EVENTS_AND_LOGS_DATA, MONITORING_DATA
The type of SFD data being backed up.
version string
Restored SFD version
acknowledged_by string
User id of NFC operator who previously have acknowledged this restore.
acknowledged_at integer
The time in seconds since epoch at which this restore was acknowledged by NFC operator. This
eld is empty if the acknowledge is in FALSE state.
start_time integer
Time at which last restore was started. The timestamp is dened in epoch milliseconds.
end_time integer
Time at which last restore was completed. The timestamp is dened in epoch milliseconds.
restore_status enum ALLOWED:SUCCESS, FAILED, NOT_SET, ACK
Restore status
message string
detailed success or failure message about restore
}
state enum ALLOWED:NOT_STARTED, DOWNLOADING_FILE_IN_PROGRESS,
DOWNLOADING_FILE_FAILED, VALIDATION_IN_PROGRESS,
VALIDATION_SUCCESS, VALIDATION_FAILED, RESTORE_STARTED,
RESTORE_COMPLETED, RESTORE_FAILED
Describe the current status of restore.
error_message string
Showing the error message when restore failed
}
STATUS CODE - 401: You are not authorized to perform this operation.
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
}]
}
STATUS CODE - default: success or error response
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
67 of 340