API Guide

Severity level of the events/alerts
created_timestamp integer
The time in seconds since epoch at which the alert was generated.
modified_timestamp integer
The time in seconds since epoch at which the alert was modied.
cleared_timestamp integer
The time in seconds since epoch at which the alert was cleared/resolved.
message string
Detailed message describing the alert type raised on a NFC managed object id
referenced_object_id {
This object denes the NFC object type and the unique identier for that object type
id string
Unique identier of the referenced object
type string
Type of referenced object. Ex - Interface, Switch, etc
}
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.
state_updated_by string
User id of NFC operator or SFD system who has most recently updated the alert state.
}]
}
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
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.2 POST /alerts/{id}/ack
12 of 340