@itentialopensource/adapter-versa_director
Version:
This adapter integrates with system described as: versaDirectorApi.
1,866 lines • 626 kB
JSON
{
"id": "@itentialopensource/adapter-versa_director",
"type": "Adapter",
"export": "VersaDirector",
"title": "Versa_director",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [
{
"name": "maxCalls",
"required": false,
"type": "number",
"info": "How many GET endpoints to test (defaults to 5)",
"schema": {
"title": "maxCalls",
"type": "number",
"default": 5
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the Itential Platform database",
"description": "Moves entities from an adapter into the Itential Platform database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "assignAlarmObject",
"summary": "Assign an alarm",
"description": "Assign an alarm to a user",
"input": [
{
"name": "alarm",
"type": "string",
"info": "alarm: string",
"required": false,
"schema": {
"title": "alarm",
"type": "string"
}
},
{
"name": "assignee",
"type": "string",
"info": "Username of assignee: string",
"required": true,
"schema": {
"title": "assignee",
"type": "string"
}
},
{
"name": "description",
"type": "string",
"info": "Description of the handling action: string",
"required": true,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "state",
"type": "string",
"info": "New handling state: string",
"required": true,
"schema": {
"title": "state",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/assignAlarmObject"
},
"task": true
},
{
"name": "updateAlarmAssignee",
"summary": "Assign an alarm",
"description": "Assign an alarm to a user",
"input": [
{
"name": "assignee",
"type": "string",
"info": "Username of assignee: string",
"required": true,
"schema": {
"title": "assignee",
"type": "string"
}
},
{
"name": "description",
"type": "string",
"info": "Description of the handling action: string",
"required": true,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "deviceName",
"type": "string",
"info": "Device name: string",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "managedObject",
"type": "string",
"info": "Managed object of alarm: string",
"required": true,
"schema": {
"title": "managedObject",
"type": "string"
}
},
{
"name": "org",
"type": "string",
"info": "Organization name: string",
"required": true,
"schema": {
"title": "org",
"type": "string"
}
},
{
"name": "specificProblem",
"type": "string",
"info": "Specific problem that caused alarm (optional): string",
"required": false,
"schema": {
"title": "specificProblem",
"type": "string"
}
},
{
"name": "state",
"type": "string",
"info": "New handling state: string",
"required": true,
"schema": {
"title": "state",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "Alarm type: string",
"required": true,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateAlarmAssignee"
},
"task": true
},
{
"name": "clearAlarm",
"summary": "Clear an alarm",
"description": "Clearm with given parameters",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "Device name: string",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "managedObject",
"type": "string",
"info": "Managed object of alarm: string",
"required": true,
"schema": {
"title": "managedObject",
"type": "string"
}
},
{
"name": "org",
"type": "string",
"info": "Organization name: string",
"required": true,
"schema": {
"title": "org",
"type": "string"
}
},
{
"name": "specificProblem",
"type": "string",
"info": "Specific problem that caused alarm (optional): string",
"required": false,
"schema": {
"title": "specificProblem",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "Alarm type: string",
"required": true,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/clearAlarm"
},
"task": true
},
{
"name": "handleAlarmObject",
"summary": "Handle an alarm",
"description": "Handle an alarm",
"input": [
{
"name": "alarmAlarmHandlings0AssignedBy",
"type": "string",
"info": "The person doing the assignment: string",
"required": false,
"schema": {
"title": "alarmAlarmHandlings0AssignedBy",
"type": "string"
}
},
{
"name": "alarmAlarmHandlings0Description",
"type": "string",
"info": "Description of the handling/assignment: string",
"required": false,
"schema": {
"title": "alarmAlarmHandlings0Description",
"type": "string"
}
},
{
"name": "alarmAlarmHandlings0State",
"type": "string",
"info": "New handling state: string",
"required": false,
"schema": {
"title": "alarmAlarmHandlings0State",
"type": "string"
}
},
{
"name": "alarmAlarmHandlings0Time",
"type": "string",
"info": "When handling/assignement happened: string",
"required": false,
"schema": {
"title": "alarmAlarmHandlings0Time",
"type": "string"
}
},
{
"name": "alarmAlarmHandlings0User",
"type": "string",
"info": "The person alarm was assigned to: string",
"required": false,
"schema": {
"title": "alarmAlarmHandlings0User",
"type": "string"
}
},
{
"name": "alarmDevice",
"type": "string",
"info": "Device name: string",
"required": false,
"schema": {
"title": "alarmDevice",
"type": "string"
}
},
{
"name": "alarmDeviceGroup",
"type": "string",
"info": "Device group: string",
"required": false,
"schema": {
"title": "alarmDeviceGroup",
"type": "string"
}
},
{
"name": "alarmDeviceName",
"type": "string",
"info": "Device name where alarm comes from: string",
"required": false,
"schema": {
"title": "alarmDeviceName",
"type": "string"
}
},
{
"name": "alarmIsCleared",
"type": "string",
"info": "Whether the alarm has been cleared: string",
"required": false,
"schema": {
"title": "alarmIsCleared",
"type": "string"
}
},
{
"name": "alarmLastAlarmText",
"type": "string",
"info": "Alarm description if any: string",
"required": false,
"schema": {
"title": "alarmLastAlarmText",
"type": "string"
}
},
{
"name": "alarmLastPerceivedSeverity",
"type": "string",
"info": "Current severity of the alarm: string",
"required": false,
"schema": {
"title": "alarmLastPerceivedSeverity",
"type": "string"
}
},
{
"name": "alarmLastStatusChangeTimeStamp",
"type": "string",
"info": "Last time an instance of this alarm came: string",
"required": false,
"schema": {
"title": "alarmLastStatusChangeTimeStamp",
"type": "string"
}
},
{
"name": "alarmObject",
"type": "string",
"info": "The particular object that generated the alarm: string",
"required": false,
"schema": {
"title": "alarmObject",
"type": "string"
}
},
{
"name": "alarmOrg",
"type": "string",
"info": "Tenant name: string",
"required": false,
"schema": {
"title": "alarmOrg",
"type": "string"
}
},
{
"name": "alarmSerial",
"type": "string",
"info": "Serial number: string",
"required": false,
"schema": {
"title": "alarmSerial",
"type": "string"
}
},
{
"name": "alarmSeverity",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "alarmSeverity",
"type": "string"
}
},
{
"name": "alarmStatusChanges0AlarmText",
"type": "string",
"info": "Alarm text: string",
"required": false,
"schema": {
"title": "alarmStatusChanges0AlarmText",
"type": "string"
}
},
{
"name": "alarmStatusChanges0EventTime",
"type": "string",
"info": "When the alarm was generated: string",
"required": false,
"schema": {
"title": "alarmStatusChanges0EventTime",
"type": "string"
}
},
{
"name": "alarmStatusChanges0ReceivedTime",
"type": "string",
"info": "When the alarm was received by director: string",
"required": false,
"schema": {
"title": "alarmStatusChanges0ReceivedTime",
"type": "string"
}
},
{
"name": "alarmStatusChanges0Severity",
"type": "string",
"info": "Severity of the alarm when it was received: string",
"required": false,
"schema": {
"title": "alarmStatusChanges0Severity",
"type": "string"
}
},
{
"name": "alarmType",
"type": "string",
"info": "Alarm type: string",
"required": false,
"schema": {
"title": "alarmType",
"type": "string"
}
},
{
"name": "assignee",
"type": "string",
"info": "Assignee: string",
"required": false,
"schema": {
"title": "assignee",
"type": "string"
}
},
{
"name": "description",
"type": "string",
"info": "Description of handling action: string",
"required": false,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "specificProblem",
"type": "string",
"info": "Specific reason for the alarm: string",
"required": false,
"schema": {
"title": "specificProblem",
"type": "string"
}
},
{
"name": "state",
"type": "string",
"info": "New handling state: string",
"required": false,
"schema": {
"title": "state",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/handleAlarmObject"
},
"task": true
},
{
"name": "updateHandleAlarm",
"summary": "Handle an alarm",
"description": "Handle an alarm",
"input": [
{
"name": "description",
"type": "string",
"info": "Description of the handling action: string",
"required": true,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "deviceName",
"type": "string",
"info": "Device name: string",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "managedObject",
"type": "string",
"info": "Managed object of alarm: string",
"required": true,
"schema": {
"title": "managedObject",
"type": "string"
}
},
{
"name": "org",
"type": "string",
"info": "Organization name: string",
"required": true,
"schema": {
"title": "org",
"type": "string"
}
},
{
"name": "specificProblem",
"type": "string",
"info": "Specific problem that caused alarm (optional): string",
"required": true,
"schema": {
"title": "specificProblem",
"type": "string"
}
},
{
"name": "state",
"type": "string",
"info": "New handling state: string",
"required": true,
"schema": {
"title": "state",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "Alarm type: string",
"required": true,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/updateHandleAlarm"
},
"task": true
},
{
"name": "getAlarmHandling",
"summary": "Retrieve handlings associated with an alarm",
"description": "Retrieve handlings associated with an alarm",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "Device name: string",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "managedObject",
"type": "string",
"info": "Managed object of alarm: string",
"required": true,
"schema": {
"title": "managedObject",
"type": "string"
}
},
{
"name": "org",
"type": "string",
"info": "Organization name: string",
"required": true,
"schema": {
"title": "org",
"type": "string"
}
},
{
"name": "specificProblem",
"type": "string",
"info": "Specific problem that caused alarm (optional): string",
"required": false,
"schema": {
"title": "specificProblem",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "Alarm type: string",
"required": true,
"schema": {
"title": "type",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getAlarmHandling"
},
"task": true
},
{
"name": "getAlarmHandlingObject",
"summary": "Retrieve handlings associated with an alarm",
"description": "Retrieve handlings associated with an alarm",
"input": [
{
"name": "alarmHandlings0AssignedBy",
"type": "string",
"info": "The person doing the assignment: string",
"required": false,
"schema": {
"title": "alarmHandlings0AssignedBy",
"type": "string"
}
},
{
"name": "alarmHandlings0Description",
"type": "string",
"info": "Description of the handling/assignment: string",
"required": false,
"schema": {
"title": "alarmHandlings0Description",
"type": "string"
}
},
{
"name": "alarmHandlings0State",
"type": "string",
"info": "New handling state: string",
"required": false,
"schema": {
"title": "alarmHandlings0State",
"type": "string"
}
},
{
"name": "alarmHandlings0Time",
"type": "string",
"info": "When handling/assignement happened: string",
"required": false,
"schema": {
"title": "alarmHandlings0Time",
"type": "string"
}
},
{
"name": "alarmHandlings0User",
"type": "string",
"info": "The person alarm was assigned to: string",
"required": false,
"schema": {
"title": "alarmHandlings0User",
"type": "string"
}
},
{
"name": "device",
"type": "string",
"info": "Device name: string",
"required": false,
"schema": {
"title": "device",
"type": "string"
}
},
{
"name": "deviceGroup",
"type": "string",
"info": "Device group: string",
"required": false,
"schema": {
"title": "deviceGroup",
"type": "string"
}
},
{
"name": "deviceName",
"type": "string",
"info": "Device name where alarm comes from: string",
"required": false,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "isCleared",
"type": "string",
"info": "Whether the alarm has been cleared: string",
"required": false,
"schema": {
"title": "isCleared",
"type": "string"
}
},
{
"name": "lastAlarmText",
"type": "string",
"info": "Alarm description if any: string",
"required": false,
"schema": {
"title": "lastAlarmText",
"type": "string"
}
},
{
"name": "lastPerceivedSeverity",
"type": "string",
"info": "Current severity of the alarm: string",
"required": false,
"schema": {
"title": "lastPerceivedSeverity",
"type": "string"
}
},
{
"name": "lastStatusChangeTimeStamp",
"type": "string",
"info": "Last time an instance of this alarm came: string",
"required": false,
"schema": {
"title": "lastStatusChangeTimeStamp",
"type": "string"
}
},
{
"name": "object",
"type": "string",
"info": "The particular object that generated the alarm: string",
"required": false,
"schema": {
"title": "object",
"type": "string"
}
},
{
"name": "org",
"type": "string",
"info": "Tenant name: string",
"required": false,
"schema": {
"title": "org",
"type": "string"
}
},
{
"name": "serial",
"type": "string",
"info": "Serial number: string",
"required": false,
"schema": {
"title": "serial",
"type": "string"
}
},
{
"name": "severity",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "severity",
"type": "string"
}
},
{
"name": "specificProblem",
"type": "string",
"info": "Specific reason for the alarm: string",
"required": false,
"schema": {
"title": "specificProblem",
"type": "string"
}
},
{
"name": "statusChanges0AlarmText",
"type": "string",
"info": "Alarm text: string",
"required": false,
"schema": {
"title": "statusChanges0AlarmText",
"type": "string"
}
},
{
"name": "statusChanges0EventTime",
"type": "string",
"info": "When the alarm