Versions Compared

Key

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

...

Code Block
[
    {
        "change_id": "123456ticket #1234",
        "current": "current",
        "description": "testingEmergency 123456outage",
        "endelement": 1683381540,
 [
            {
         "frequency       "element_name": "onceVlan2",
             "id   "node_name": "df0affe5-a16f-4fa2-a299-5376a3fabb73",
Switch-1"
            },
            "nodes": {
{
                "element_name": "regex:^Vlan.*?$",
                "groupnode_name": ["Switch-2"
            }
        ],
        "HQDevend": 1684156863,
        "frequency": "once",
   ],
     "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
        "nodes": {
            "name": [
                "Switch-2",
                "Switch-1"
            ]
        },
        "options": {},
        "nodeStatusstart": [ 1683811263
    },
    {
        "change_id": "Outage_123_AT_OPTESTS",
        "reachablecurrent": null,
        "description": "Emergency outage",
        "end": ]1683825925,
        "frequency": "once",
        "nodeTypeid": ["ea7a3a94-f056-432f-91c5-9f39eee7c706",
        "nodes": {
            "switchname",: [
                "serverasgard",
                "genericapc-ups"
            ]
        },
        "options": {},
        "nodeVendorstart": [ 1646918463
    }
]



Get Outage

GET http://server/en/omk/admin/api/v3/outages/#ID

Ex. http://server/en/omk/admin/api/v3/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4

Returns an outage.

Response:


Code Block
{
    "change_id": "ticket #1234",
    "current": "current",
    "description": "Emergency outage"Cisco Systems",
    "element": [
        {
    ]        "element_name": "Vlan2",
            "roleTypenode_name": [
"Switch-1"
        },
        {
  "test2"          "element_name": "regex:^Vlan.*?$",
            ] "node_name": "Switch-2"
        },
    ],
    "optionsend": {1684156863,
    "frequency": "once",
    "id": "0ea7644e-b6fa-4fa2-9b33-a86b79db21a4",
    "nostatsnodes": 0{},
    "options": {},
    },"start": 1683811263
}



Create Outage

POST http://server/en/omk/admin/api/v3/outages

Returns 200 if the outage was successfully created.

Payload example:


Code Block
{
    "change_id": "ticket #1234",
    "startdescription": 1683122400 "Emergency outage",
    }"nodes": ["Switch-2","Switch-1"],
    {"elements" : [
        {  "changenode_idname": "Switch-1",
        "current"   "element_name" : "current"Vlan2"
        },
        "description{  "node_name": "testSwitch-outage2",
           "end": 1683381540,element_name" : "regex:^Vlan.*?$"
        }
    ],
    "frequencystart": "once11-May-2023 23:21:03",
    "end": "15-May-2023 23:21:03"
}


Returns:

Code Block
{
    "id": "10d3558d0ea7644e-1819b6fa-44924fa2-8ff59b33-a5629663e0d7a86b79db21a4",
    "success": 1
}

Update Outage

PUT http://server/en/omk/admin/api/v3/outages/#ID

Returns 200 if the outage was successfully updated.

Payload example:

Code Block
{
    "nodeschange_id": { "ticket #1234",
    "description": "Emergency outage",
      "namenodes": ["Switch-2","Switch-1"],
    "elements" : [
        {  "node_name": "fullaSwitch-1",
            ]"element_name" : "Vlan222"
        },
        {  "optionsnode_name": {"Switch-2",
            "nostatselement_name" : 0"regex:^Vlan.*?$"
        },
    ],
    "start": 1683122400"11-May-2023 23:21:03",
    "end": "15-May-2023 23:21:03"
}
]


Return 

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



Delete Outage

DELETE http://server/en/omk/admin/api/v3/outages/0ea7644e-b6fa-4fa2-9b33-a86b79db21a4

Returns 200 if the outage was successfully removed.