API Guide

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.
}]
}
2.6 GET /alerts/{id}/timeline
Returns the alert timeline by alert Id
This API returns the alert timeline history. Each record in the timeline will describe the status of an alert at a given
timestamp
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
The id of an alert.
RESPONSE
STATUS CODE - 200: Response to get the timeline of an alert
RESPONSE MODEL - application/json
{
Maintains the record of alerts timeline.
data [{
Array of object: Denes the status of an alert when an alert is modied/updated. If an alert is updated, a new record is added to the alert
history timeline.
timestamp integer
The time in seconds since epoch at which alert was modied.
updated_by string
The user id of NFC operator or SFD system who is responsible for modifying the alert object.
state enum ALLOWED:OPEN, ACK, CLEARED
State of an alert. It can be in OPEN, ACK or CLEARED state. OPEN state means an alert is newly created
or is un-acked by NFC operator. ACK state means NFC operator has acknowledged an alert. CLEARED
state means that alert has been resolved and is no longer active.
message string
Message describing update of the alert
}]
}
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.
}]
19 of 340