Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Ex. http://server/en/omk/admin/api/v2/outages/0ea7644ee17b6efa-b6faa3da-4fa24281-9b33919c-a86b79db21a4bef26b96ff80

Returns an outage.

Response:

Code Block
{
    "change_id": "ticket #1234001",
    "current": "current",
    "description": "Emergencytesting outage 1",
    "elementelements": [
        {
            "element_name": "Vlan2Vlan11",
            "node_name": "Switch-1Asgard"
        },
        {],
    "end": 1684763940,
       "element_name"frequency": "regex:^Vlan.*?$once",
        "id": "e17b6efa-a3da-4281-919c-bef26b96ff80",
    "node_namenodes": "Switch-2"[
        }"Asgard"
    ],
    "endoptions": 1684156863,{
        "frequencynostats": "once"0
    },
    "idstart": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
    "nodes": {},
    "options": {},
    "start": 1683811263
}1684072800
}


POST of /v2/outages/ for Create

...

Code Block
{
    "change_id": "ticket #1234",
    "description": "Emergency outage",
    "nodeselements" : ["Switch-2","Switch-1"],
    "elements" : [

           {  "node_name": "Switch-1",
           "element_name" : "Vlan2"
        },
        {  "node_name": "Switch-2",
           "element_name" : "regex:^Vlan.*?$"
        }
    ],
    "start": "11-May-2023 23:21:03"03",
    "end": "15-May-2023 23:21:03"
}


###############################################


{
    "change_id": "001",
    "current": "current",
    "description": "testing outage 1",
    "end": 1684763940,
    "frequency": "once",
    "nodes":["Switch1","Switch-111"],
    "options": {
        "nostats": 0
    },
    "endstart": "15-May-2023 23:21:03"1684072800
}

Return

Code Block
{
    "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
    "success": 1
}

PUT of /v2/outages/

...

 for Update

Create an Outage by sending a pay-load JSON object and this will create an Outage on your system and receive an appropriate response.

...

Payload example:

Code Block
{
	"id" : XXXXXXXXXXXXXXXXXXXXXX,
    "change_id": "ticket #1234",
    "description": "Emergency outage",
    "nodes": ["Switch-2","Switch-1"],
    "elements" : [
        {  "node_name": "Switch-1",
           "element_name" : "Vlan222"
        },
        {  "node_name": "Switch-2",
           "element_name" : "regex:^Vlan.*?$"
        }
    ],
    "start": "11-May-2023 23:21:03",
    "end": "15-May-2023 23:21:03"
}

...