...
HTTP Status | Body | Description |
|---|---|---|
| 400 Bad Request | JSON object with an error property | The error property contains an explanation of what went wrongwith your request, e.g. if id is missing or wrong format. |
| 404 Not Found | JSON object with an error property | If the your id does not exist of wrong id format. |
| 401 Unauthorized | JSON object with an error property | You are not authenticated. |
| 404 Not Found | JSON object with an error property | You are authenticated but not authorised to delete an Outage. |
...
Property | Description | Example |
| A globally unique Outage ID | 0ea7644e-b6fa-4fa2-9b33-a86b79db21a4 |
change_id | Insert any reference number if required in the change id field | ticket #12345 |
current | If the outage is current or scheduled/future outage. IS THIS 'current' for scheduled or null for future. | current |
description | Long description of an Outage | This is a test outage |
frequency | one of 'once', 'daily', 'weekly' or 'monthly' | once |
start | date and time of outage start.See For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC | 2023-10-31T17:00:00+0000 |
end | date and time of outage end. See For Read, this is a Unix timestamp, the number of seconds since 1970-01-01 00:00:00 UTC For Create and Update see Supported Time Formats for for description of allowed values.values | 31 May 2023 03:30 pm |
nodes | List of nodes for which Outages is defined. IS THIS MANDATORY?. At least one of nodes or elements must be specified. | [ 'Switch-1','Switch-2' ] |
element | List of elements from nodes for which Outages are defined.IS THIS MANDATORY? DOCUMENT REGEX OR SEE LINK CAN I DO NODE REGEX? HOW DO WE HANDLE OTHER TYPES OF ELEMENTS | [ { "element_name": "Vlan2", "element_name": "regex:^Vlan.*?$", [ { "node_name": "Switch-1" "element_name": "regex:^Vlan.*?$", |
options | optional key=values to adjust NMIS behaviour during an outage DOCUMENT THE KEYS AND VALUES | "Normal" |
...