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
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
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.5 GET /alerts/{id}/events
Get list of events for an alert.
This API returns the list of events related to an alert.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
The id of an alert.
RESPONSE
STATUS CODE - 200: Response to get all the NFC events
RESPONSE MODEL - application/json
{
Get all the nfc events
data [{
Array of object: Nfc event object
id string
Unique identier of the nfc event object
type string
Type of event generated. Ex: INTERFACE_LINK_DOWN_EVENT
severity enum ALLOWED:INFO, WARNING, ERROR, CRITICAL, CLEARED
17 of 340