...
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 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 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
...
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 |
|---|---|---|
| 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
...