Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET error_display_notification_agents
Resource Information
Requires Authentication? | |
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
| Code Block | ||
|---|---|---|
| ||
[
{
"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? | |
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 | integer | The ID of the desired Error Display Agent to be viewed. |
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"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? | |
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
Body:
| Code Blockcode | ||
|---|---|---|
| ||
{
"ErrorDisplayNotificationAgent": {
"decay_after_clear": "20",
"min_display_time": "20",
"title": "errAgent"
}
} |
Response:
| Code Block |
|---|
{
"ErrorDisplayNotificationAgent": {
"id": 3,
"title": "errAgent1",
"decay_after_clear": 20,
"min_display_time": 20,
"is_remove_static": 0,
"is_single_instance": 0,
"modified": "1618658511334",
"created": "1618658511334"
}
}
|
POST error_display_notification_agents/{id}
Resource Information
Requires Authentication? | |
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 | integer | The ID of the desired Error Display Agent to be copied. |
Example Request
POST
Body:
| Code Block |
|---|
{
"ErrorDisplayNotificationAgent": {
"decay_after_clear": "20",
"min_display_time": "20",
"title": "errAgent"
}
}
|
Response:
code| Code Block | ||
|---|---|---|
| ||
{
"ErrorDisplayNotificationAgent": {
"id": 4,
"title": "errAgent_2",
"decay_after_clear": 20,
"min_display_time": 20,
"is_remove_static": 0,
"is_single_instance": 0,
"modified": "1618662791973",
"created": "1618662791973"
}
}
|
|
PUT error_display_notification_agents/{id}
Resource Information
Requires Authentication? | |
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 | integer | The ID of the desired Error Display Agent to be updated. |
Example Request
PUT
Body:
| Code Block |
|---|
{
"ErrorDisplayNotificationAgent": {
"decay_after_clear": "20",
"min_display_time": "20",
"title": "errAgent"
}
} |
Response:
| Code Block |
|---|
{
"ErrorDisplayNotificationAgent": {
"id": 2,
"title": "errAgent",
"decay_after_clear": 20,
"min_display_time": 20,
"is_remove_static": 0,
"is_single_instance": 0,
"modified": "1618663875037",
"created": "1618657904213"
}
} |
DELETE error_display_notification_agents/{id}
Resource Information
Requires Authentication? | |
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 | integer | The ID of the desired Error Display Agent to be deleted. |
Example Request
DELETE
| Code Block | ||
|---|---|---|
| ||
{
"success": true
} |