/
Error Display Agents

Error Display Agents

GET error_display_notification_agents

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of Error Display Agents configuration data.

Resource URL

http://{host}/api/2.0/error_display_notification_agents/.format

Example Request

GET 

  1. http://192.168.0.203/api/2.0/error_display_notification_agents/.json

[ { "ErrorDisplayNotificationAgent": { "id": 1, "title": "ErrorAgent", "decay_after_clear": 20, "min_display_time": 20, "is_remove_static": 0, "is_single_instance": 1, "modified": "1618225794279", "created": "1618225794279" } }, { "ErrorDisplayNotificationAgent": { "id": 2, "title": "errAgent", "decay_after_clear": 20, "min_display_time": 20, "is_remove_static": 0, "is_single_instance": 0, "modified": "1618657904213", "created": "1618657904213" } } ]

 


 

GET error_display_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single Error Display Agent configuration data.

Resource URL

http://{host}/api/2.0/error_display_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Error Display Agent to be viewed.

Example Request

GET 

  1. http://192.168.0.203/api/2.0/error_display_notification_agents/1/.json

"ErrorDisplayNotificationAgent": { "id": 1, "title": "ErrorAgent", "decay_after_clear": 20, "min_display_time": 20, "is_remove_static": 0, "is_single_instance": 1, "modified": "1618225794279", "created": "1618225794279" } }

 


 

POST error_display_notification_agents

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new Error Display Agent.

Resource URL

http://{host}/api/2.0/error_display_notification_agents/.format

Example Request

POST 

  1. http://192.168.0.203/api/2.0/error_display_notification_agents/.json

{ "ErrorDisplayNotificationAgent": { "decay_after_clear": "20", "min_display_time": "20", "title": "errAgent" } }

 


 

POST error_display_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Duplicates a single specific Error Display Agent into a new one, preserving all configuration data except for the title.

Resource URL

http://{host}/api/2.0/error_display_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Error Display Agent to be copied.

Example Request

POST 

  1. http://192.168.0.203/api/2.0/error_display_notification_agents/2/.json

 


 

PUT error_display_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates a single specific Error Display Agent configuration data.

Resource URL

http://{host}/api/2.0/error_display_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Error Display Agent to be updated.

Example Request

PUT 

  1. http://192.168.0.203/api/2.0/error_display_notification_agents/2/.json

 


 

DELETE error_display_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a single specific Error Display Agent.

Resource URL

http://{host}/api/2.0/error_display_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Error Display Agent to be deleted.

Example Request

DELETE 

  1. http://192.168.0.203/api/2.0/error_display_notification_agents/2/.json

Related content

API
Read with this
Display Agent
Display Agent
More like this
MCS Release Notes
MCS Release Notes
Read with this
Audio Alarm Agents
Audio Alarm Agents
More like this
MCM SW Release Notes
MCM SW Release Notes
Read with this
v5.0_Notifications
v5.0_Notifications
More like this