Operation
get /data/esmBrowser/alarmList/getAlarmStatusSummary
get alarm summary (getAlarmStatusSummary : /data/esmBrowser/alarmList/getAlarmStatusSummary)
getAlarmStatusSummary
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
AlarmDashboardSummaryList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/json
External Docs
See Also :
Operation
get /esmBrowser/alarmList/getAlarmStatusSummary
get alarm summary (getAlarmStatusSummary : /esmBrowser/alarmList/getAlarmStatusSummary)
getAlarmStatusSummary
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
AlarmDashboardSummaryList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/json
External Docs
See Also :
Operation
get /data/esmBrowser/alarmList/GetNmlEmlAlarms/{entityName}/{entityType}/{clientZoneOffset}
Fetch Alarms (getAllNmlEmlAlarmsList : /data/esmBrowser/alarmList/GetNmlEmlAlarms/{entityName}/{entityType}/{clientZoneOffset})
NML EML Alarms List is fetched
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | Client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
entityName | required | Alarm Entity Name.Possible values:Service Name/ERP Name | --- |
entityType | required | Alarm Entity type:Service/ERP | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
AlarmNMLEMLListModel
|
401Unauthorized | --- |
403Forbidden | --- |
404Alarm Sync failed |
Void
|
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/xml
External Docs
See Also :
Operation
get /esmBrowser/alarmList/GetNmlEmlAlarms/{entityName}/{entityType}/{clientZoneOffset}
Fetch Alarms (getAllNmlEmlAlarmsList : /esmBrowser/alarmList/GetNmlEmlAlarms/{entityName}/{entityType}/{clientZoneOffset})
NML EML Alarms List is fetched
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | Client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset. | --- |
entityName | required | Alarm Entity Name.Possible values:Service Name/ERP Name | --- |
entityType | required | Alarm Entity type:Service/ERP | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
AlarmNMLEMLListModel
|
401Unauthorized | --- |
403Forbidden | --- |
404Alarm Sync failed |
Void
|
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/xml
External Docs
See Also :
Operation
get /data/esmBrowser/alarmList/GetNmlEmlAlarmsJSON/{entityName}/{entityType}/{clientZoneOffset}
Fetch Alarms in JSON format (getAllNmlEmlAlarmsListJSON : /data/esmBrowser/alarmList/GetNmlEmlAlarmsJSON/{entityName}/{entityType}/{clientZoneOffset})
NML EML Alarms List is fetched
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | clientZoneOffset | --- |
entityName | required | Alarm Entity Name.Possible values:Service Name/ERP Name | --- |
entityType | required | Alarm Entity type:Service/ERP | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
AlarmNMLEMLListModel
|
401Unauthorized | --- |
403Forbidden | --- |
404Alarm Sync failed |
Void
|
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/json
External Docs
See Also :
Operation
get /esmBrowser/alarmList/GetNmlEmlAlarmsJSON/{entityName}/{entityType}/{clientZoneOffset}
Fetch Alarms in JSON format (getAllNmlEmlAlarmsListJSON : /esmBrowser/alarmList/GetNmlEmlAlarmsJSON/{entityName}/{entityType}/{clientZoneOffset})
NML EML Alarms List is fetched
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | clientZoneOffset | --- |
entityName | required | Alarm Entity Name.Possible values:Service Name/ERP Name | --- |
entityType | required | Alarm Entity type:Service/ERP | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
AlarmNMLEMLListModel
|
401Unauthorized | --- |
403Forbidden | --- |
404Alarm Sync failed |
Void
|
Example Request Data
/esmBrowser/alarmList/GetNmlEmlAlarmsJSON/Anup_1GbRingTest/ERP/+5:30?request.preventCache=1457966949
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/json
Example Response Data
{ "alarmNmlEmlData": [ { "source": "PSS32-BA-05/SLOT-1-4", "serverAlarmType": null, "neSeverity": "Major", "neAlarmType": "Primary", "neProbableCause": "Configuration Mismatch", "neOccurenceTime": "2016-03-03 20:13:46", "typeName": "--", "nmlOccurenceTime": "--", "nmlSeverity": "--", "nmlProbableCause": "--", "errorOccured": null, "entryId": 0 }, { "source": "PSS32-BA-05/SLOT-1-5", "serverAlarmType": null, "neSeverity": "Major", "neAlarmType": "Primary", "neProbableCause": "Configuration Mismatch", "neOccurenceTime": "2016-01-19 21:06:23", "typeName": "--", "nmlOccurenceTime": "--", "nmlSeverity": "--", "nmlProbableCause": "--", "errorOccured": null, "entryId": 1 }, { "source": "PSS32-BA-01/SLOT-1-6", "serverAlarmType": null, "neSeverity": "Major", "neAlarmType": "Primary", "neProbableCause": "Configuration Mismatch", "neOccurenceTime": "2016-02-29 12:27:38", "typeName": "--", "nmlOccurenceTime": "--", "nmlSeverity": "--", "nmlProbableCause": "--", "errorOccured": null, "entryId": 2 }, { "source": "PSS32-BA-02/SLOT-1-11", "serverAlarmType": null, "neSeverity": "Major", "neAlarmType": "Primary", "neProbableCause": "Configuration Mismatch", "neOccurenceTime": "2016-03-10 07:53:35", "typeName": "--", "nmlOccurenceTime": "--", "nmlSeverity": "--", "nmlProbableCause": "--", "errorOccured": null, "entryId": 3 } ], "nmlSeverity": null, "neSeverity": null }
External Docs
See Also :
Operation
get /data/esmBrowser/alarmList/GetNmlEmlAlarmsFromEntityId/{entityId}/{entityType}/{clientZoneOffset}
Fetch Alarms from Entity Id in JSON format (getNmlEmlAlarmsFromEntityId : /data/esmBrowser/alarmList/GetNmlEmlAlarmsFromEntityId/{entityId}/{entityType}/{clientZoneOffset})
NML EML Alarms List is fetched
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
client time Zone offset to be updated.The value of clientZoneOffset depends on the location of the user.Generally clientZoneOffset= UTC+Offset or UTC-Offset.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
clientZoneOffset | required | clientZoneOffset | --- |
entityId | required | Alarm Entity Name.Possible values:Service ID/ERP ID | --- |
entityType | required | Alarm Entity type:Service/ERP | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
AlarmNMLEMLListModel
|
401Unauthorized | --- |
403Forbidden | --- |
404Alarm Sync failed |
Void
|
Produces
This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.
application/json
External Docs
See Also :
AlarmDashboardSummaryList
Name |
Type |
Description |
Enum |
---|---|---|---|
items | array[Alarm Summary Data Holder] Alarm Summary Data Holder |
AlarmDashboardSummaryList | --- |
AlarmNMLEMLListModel
Name |
Type |
Description |
Enum |
---|---|---|---|
alarmNmlEmlData | array[AlarmNmlEmlUIDataModel] AlarmNmlEmlUIDataModel |
Alarm NML EML Data List | --- |
nmlSeverity | String string |
NML Alarm Severity | [CRITICAL, MAJAOR, MINOR, NA] |
neSeverity | String string |
NE Alarm Severity | [CRITICAL, MAJAOR, MINOR, NA] |
items | array[AlarmNmlEmlUIDataModel] AlarmNmlEmlUIDataModel |
--- | --- |
AlarmNmlEmlUIDataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
source | String string |
Source of the Alarm | --- |
serverAlarmType | String string |
server Alarm type | --- |
neSeverity | String string |
NE Alarm Severity | [CRITICAL, MAJOR, MINOR, NA] |
neAlarmType | String string |
NE Alarm Type | --- |
neProbableCause | String string |
NE Alarm probable cause | --- |
neOccurenceTime | String string |
NE Alarm occurence time | --- |
typeName | String string |
Alarm type name | --- |
nmlOccurenceTime | String string |
NML Alarm Occurence time | --- |
nmlSeverity | String string |
NML Alarm severity | --- |
nmlProbableCause | String string |
NML Alarm probable cause | --- |
specificproblem | String string |
NE SA/NSA | --- |
id | Integer integer |
--- | --- |
key | String string |
--- | --- |
className | String string |
--- | --- |
ElementaryAlarmListUIData
Name |
Type |
Description |
Enum |
---|---|---|---|
elementaryAlarmData | array[ElementaryAlarmUIData] ElementaryAlarmUIData |
--- | --- |
Void
Name |
Type |
Description |
Enum |
---|