-
Notifications
You must be signed in to change notification settings - Fork 6
plannedoutages
Retrieves the speficic outage, identified by an unique id
URI: /v1/plannedoutagesystem/{id}
Method: GET
{id}
: (URL) numerical ID of the outage instance.
Outage object:
(long) id
: numerical ID of the outage instance
(string) externalSystemCode
: code of the system being affected by the outage
(dateTime) startOutageTimestamp
: start of the outage
(dateTime) endOutageTimestamp
: end of the outage
(string) description
: Outage description
{
"id":2,
"externalSystemCode":"CRM",
"startOutageTimestamp":"2015-06-29T23:05:00.000Z",
"endOutageTimestamp":"2015-06-30T19:45:00.000Z",
"description": "HW upgrade"
}
Deletes the outage identified by an unique id
URI: /v1/plannedoutagesystem/{id}
Method: DELETE
{id}
: (URL) numerical ID of the outage instance.
N/A
Updates the parameters of a specific outage.
URI: /v1/plannedoutagesystem/
Method: PUT
Outage object - see above for details
N/A
Creates a new outage and returns its outage ID.
URI: /v1/plannedoutagesystem/
Method: POST
Outage object - see above for details
numerical ID of the new outage instance.
Retrieve the list of all defined outages.
URI: /v1/plannedoutagesystem/findAll
Method: GET
N/A
Array of outage objects. See above for the description of outage object's fields.
[
{
"id":2,
"externalSystemCode":"CRM",
"startOutageTimestamp":"2015-06-29T23:05:00.000Z",
"endOutageTimestamp":"2015-06-30T19:45:00.000Z",
"description": "HW upgrade"
},
{
"id":3,
"externalSystemCode":"BILLING",
"startOutageTimestamp":"2015-06-29T23:05:00.000Z",
"endOutageTimestamp":"2015-06-30T19:45:00.000Z",
"description": "HW upgrade"
}
]
For a given outage it verifies whether it collides with some already defined outage for the same system. Used eg. in GUI as a validator during the definition of a new outage.
URI: /v1/plannedoutagesystem/hasSystemOutage
Method: POST
Outage object - see above for details
TRUE: The