...
Now, it is also possible to manage Outages within the Administration console or API.
The v3 api has added support for "ELEMENT OUTAGES" and this is not backward compatible with v2 api. If you make a v2 api call, it will not return any outages that are "ELEMENT OUTAGES".
See ALL ABOUT ELEMENT OUTAGES
Public API for Outages "http[s]://server/en/omk/admin/api/v3/outages"
We can view Enterprise Services Outages below using these endpoints - http[s]://server/en/omk/admin/api/v3/outages
...
Request Method | Operation | URL Example | id required | Notes |
|---|---|---|---|---|
| GET | read list | /server/omk/admin/v3/outages | n | Returns a list of Enterprise ServicesOutages. |
| GET | read one | /server/omk/admin/v3/outages/id | y | Returns the details of one Enterprise ServiceOutage . |
| POST | create one | /server/omk/admin/v3/outages | n | Create an Outage for given node or element |
| PUT | update one | /server/omk/admin/v3/outages/id | y | Edit an already existing outage data |
| DELETE | delete one | /server/omk/admin/v3/outages/id | y | Delete an existing outage |
...
Create an Outage by sending a pay-load JSON object and This this will create an Outage on your system and receive send an appropriate response.
Successful Response
HTTP Status | Body | Description |
|---|---|---|
| 201 | JSON object with success and id properties | The success property is set to 1 and only if the request was successful. The id property is the new event's ID |
Unsuccessful Response
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 your payload is of wrong format to create an Outage. |
| 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 create an Outage. |
Create Outage
POST http://server/en/omk/admin/api/v3/outages
...
| Code Block |
|---|
{
"id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
"success": 1
} |
PUT of /v3/outages/<id> for
...
Update
Create an Outage by sending a pay-load JSON object and This this will create an Outage on your system and receive an appropriate response.
Successful Response
HTTP Status | Body | Description |
|---|---|---|
| 201 | JSON object with success and id properties | The success property is set to 1 and only if the request was successful. The id property is the new event's ID |
Unsuccessful Response
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 your payload is of wrong format to edit an Outage. |
| 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 create an Outage. |
Update Outage
PUT http://server/en/omk/admin/api/v3/outages/#ID
...
Create an Outage by sending a pay-load JSON object and This will create an Outage on your system and receive an appropriate response.
Successful Response
HTTP Status | Body | Description |
|---|---|---|
| 200 | JSON object with success | The success property is set to 1 and only if the request was successful. |
Unsuccessful Response
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 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. |
Delete Outage
DELETE http://server/en/omk/admin/api/v3/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4
...
Property | Description | Example | |
| A globally unique Outage ID "63576103ad794974594a1f11" | 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 'currrent' for scheduled or null for future. | current"current/null" | |
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 date and time of outage start and end. See XYZ for description of allowed values. | 2023 e.g. 2017-10-31T03:0400:2600+0000 | |
end | date and time of outage start and end | date and time of outage end. See XYZ for description of allowed values. | 2023 e.g. 2017-10-31T03:0430:2600+0000 |
nodes | List of nodes for which Outages is defined. IS THIS MANDATORY? | [ '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? | [ { "element_name": "Vlan2", "element_name": "regex:^Vlan.*?$", | |
options | optional key=values to adjust NMIS 'behaviour during an outageooutage DOCUMENT THE KEYS AND VALUES | "Normal" | |
Limitations
API Endpoint
...