@itentialopensource/adapter-versa_director/entities/Alarms/action.json

This adapter integrates with system described as: versaDirectorApi.

{
  "actions": [
    {
      "name": "assignAlarmObject",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/assign?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "updateAlarmAssignee",
      "protocol": "REST",
      "method": "PUT",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/assign?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "clearAlarm",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/clear?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "handleAlarmObject",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/handle?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "updateHandleAlarm",
      "protocol": "REST",
      "method": "PUT",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/handle?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "getAlarmHandling",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/handling?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schemaResp.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getAlarmHandling-default.json"
        }
      ]
    },
    {
      "name": "getAlarmHandlingObject",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/handling?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schemaResp.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getAlarmHandlingObject-default.json"
        }
      ]
    },
    {
      "name": "purgeAlarmObject",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/object/purge?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "purgeAlarm",
      "protocol": "REST",
      "method": "DELETE",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/purge?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "getStatusChange",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/status?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schemaResp.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getStatusChange-default.json"
        }
      ]
    },
    {
      "name": "getStatusChangeObject",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarm/status?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schemaResp.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getStatusChangeObject-default.json"
        }
      ]
    },
    {
      "name": "getAllFilteredAlarms",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getAllFilteredAlarms-default.json"
        }
      ]
    },
    {
      "name": "assignAllFilteredAlarms",
      "protocol": "REST",
      "method": "PUT",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/assign?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "assignAllAlarms",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/bulk/assign?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "clearAllAlarms",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/bulk/clear?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "purgeAllAlarms",
      "protocol": "REST",
      "method": "POST",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/bulk/delete?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "handleAllAlarms",
      "protocol": "REST",
      "method": "PUT",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/bulk/handle?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "handleAllFilteredAlarms",
      "protocol": "REST",
      "method": "PUT",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/handle?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "filterPaginateAlarm",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/page?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/filterPaginateAlarm-default.json"
        }
      ]
    },
    {
      "name": "purgeAllFilteredAlarms",
      "protocol": "REST",
      "method": "DELETE",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/purge?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": ""
        }
      ]
    },
    {
      "name": "getAlarmSummary",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/summary?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getAlarmSummary-default.json"
        }
      ]
    },
    {
      "name": "getDeviceAlarmSummary",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/summary/device/{pathv1}?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getDeviceAlarmSummary-default.json"
        }
      ]
    },
    {
      "name": "getAlarmSummaryPerOrg",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/alarms/summary/{pathv1}?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getAlarmSummaryPerOrg-default.json"
        }
      ]
    },
    {
      "name": "getDirectorAlarms",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/director/alarms?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getDirectorAlarms-default.json"
        }
      ]
    },
    {
      "name": "getDirectorAlarmSummary",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/director/alarms/summary?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getDirectorAlarmSummary-default.json"
        }
      ]
    },
    {
      "name": "getDirectorFailOverAlarms",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/director/fail-over-alarms?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getDirectorFailOverAlarms-default.json"
        }
      ]
    },
    {
      "name": "getDirectorHAAlarms",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/director/ha-alarms?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getDirectorHAAlarms-default.json"
        }
      ]
    },
    {
      "name": "getImpAlarms",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/director/pop-up?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getImpAlarms-default.json"
        }
      ]
    },
    {
      "name": "getImpAlarmSummary",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/director/pop-up-summary?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getImpAlarmSummary-default.json"
        }
      ]
    },
    {
      "name": "getAlarmTypes",
      "protocol": "REST",
      "method": "GET",
      "entitypath": "{base_path}/{version}/vnms/fault/types?{query}",
      "requestSchema": "schema.json",
      "responseSchema": "schema.json",
      "timeout": 0,
      "sendEmpty": false,
      "sendGetBody": false,
      "requestDatatype": "JSON",
      "responseDatatype": "JSON",
      "headers": {},
      "responseObjects": [
        {
          "type": "default",
          "key": "",
          "mockFile": "mockdatafiles/getAlarmTypes-default.json"
        }
      ]
    }
  ]
}