@itentialopensource/adapter-servicenow
Version:
This adapter integrates with system described as: servicenowMadrid.
1,788 lines (1,787 loc) • 221 kB
JSON
{
"id": "@itentialopensource/adapter-servicenow",
"type": "Adapter",
"export": "Servicenow",
"title": "Servicenow",
"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": "queryTableByNameAndId",
"summary": "Retrieves the record identified by the specified sys_id from the specified table.",
"description": "Retrieves the record identified by the specified sys_id from the specified table.",
"input": [
{
"name": "tableName",
"type": "string",
"info": "Name of the table from which to retrieve the records.",
"required": true,
"schema": {
"title": "tableName",
"type": "string"
}
},
{
"name": "recordId",
"type": "string",
"info": "Unique identifier of the record to retrieve.",
"required": true,
"schema": {
"title": "recordId",
"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": "/queryTableByNameAndId"
},
"task": true
},
{
"name": "queryTableByName",
"summary": "Retrieves all the record in the table",
"description": "Retrieves all the records from the specified table.",
"input": [
{
"name": "tableName",
"type": "string",
"info": "Name of the table from which to retrieve the records.",
"required": true,
"schema": {
"title": "tableName",
"type": "string"
}
},
{
"name": "sysparmQuery",
"type": "object",
"info": "e.g. { number: 'CHG12345' }",
"required": false,
"schema": {
"title": "sysparmQuery",
"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": "/queryTableByName"
},
"task": true
},
{
"name": "queryTableByNameWithLimit",
"summary": "Retrieves a limited number of records in the table",
"description": "Retrieves a limited number of records in the table",
"input": [
{
"name": "tableName",
"type": "string",
"info": "Name of the table from which to retrieve the records.",
"required": true,
"schema": {
"title": "tableName",
"type": "string"
}
},
{
"name": "sysparmQueryKeyValuePairs",
"type": "object",
"info": "e.g. { number: 'CHG12345' }",
"required": false,
"schema": {
"title": "sysparmQuery",
"type": "object"
}
},
{
"name": "sysparmQueryString",
"type": "string",
"info": "e.g. number=CHG12345",
"required": false,
"schema": {
"title": "sysparmQuery",
"type": "string"
}
},
{
"name": "sysparmLimit",
"type": "number",
"info": "e.g. 5",
"required": false,
"schema": {
"title": "sysparmLimit",
"type": "object"
}
},
{
"name": "sysparmFields",
"type": "string",
"info": "e.g. name,description",
"required": false,
"schema": {
"title": "sysparmFields",
"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": "/queryTableByNameWithLimit"
},
"task": true
},
{
"name": "createRecordInTable",
"summary": "Inserts one record in the specified table. Multiple record insertion is not supported by this method.",
"description": "Inserts one record in the specified table. Multiple record insertion is not supported by this method.",
"input": [
{
"name": "tableName",
"type": "string",
"info": "Name of the table from which to retrieve the records.",
"required": true,
"schema": {
"title": "tableName",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": "",
"required": true,
"schema": {
"title": "body",
"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": "/createRecordInTable"
},
"task": true
},
{
"name": "updateTableRecord",
"summary": "Updates the specified record with the request body.",
"description": "Updates the specified record with the request body.",
"input": [
{
"name": "tableName",
"type": "string",
"info": "Name of the table from which to retrieve the records.",
"required": true,
"schema": {
"title": "tableName",
"type": "string"
}
},
{
"name": "recordId",
"type": "string",
"info": "Unique identifier of the record to retrieve.",
"required": true,
"schema": {
"title": "recordId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": "name-value pairs for the field(s) to update in the associated table. For example, to update the short description file, enter a name-value pair similar to the following: ...(description truncated)",
"required": true,
"schema": {
"title": "body",
"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": "/updateTableRecord"
},
"task": true
},
{
"name": "deleteTableRecord",
"summary": "Deletes the specified record from the specified table.",
"description": "Deletes the specified record from the specified table.",
"input": [
{
"name": "tableName",
"type": "string",
"info": "Name of the table from which to retrieve the records.",
"required": true,
"schema": {
"title": "tableName",
"type": "string"
}
},
{
"name": "recordId",
"type": "string",
"info": "Unique identifier of the record to retrieve.",
"required": true,
"schema": {
"title": "recordId",
"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": "/deleteTableRecord"
},
"task": true
},
{
"name": "getAgentPresence",
"summary": "Sets the state of a provided agent’s presence and sets the agent’s channel availability for that state (if provided).",
"description": "Sets the state of a provided agent’s presence and sets the agent’s channel availability for that state (if provided).",
"input": [
{
"name": "agentId",
"type": "string",
"info": "The id of the user listed in sys_user table.",
"required": true,
"schema": {
"title": "agentId",
"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": "/getAgentPresence"
},
"task": true
},
{
"name": "setAgentPresence",
"summary": "Sets the state of a provided agent’s presence and sets the agent’s channel availability for that state (if provided).",
"description": "Sets the state of a provided agent’s presence and sets the agent’s channel availability for that state (if provided).",
"input": [
{
"name": "agentId",
"type": "string",
"info": "The id of the user listed in sys_user table.",
"required": true,
"schema": {
"title": "agentId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": "",
"required": true,
"schema": {
"title": "body",
"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": "/setAgentPresence"
},
"task": true
},
{
"name": "getStandardChangeRequest",
"summary": "Retrieves one or more standard change requests based on the specified criteria.",
"description": "Retrieves one or more standard change requests based on the specified criteria.",
"input": [
{
"name": "sysparmQuery",
"type": "object",
"info": "Encoded query used to filter the result set. e.g. { change: 'CHG123456' }",
"required": false,
"schema": {
"title": "sysparmQuery",
"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": "/getStandardChangeRequest"
},
"task": true
},
{
"name": "getStandardChangeRequestById",
"summary": "Retrieves the standard change request identified by the specified sys_id.",
"description": "Retrieves the standard change request identified by the specified sys_id.",
"input": [
{
"name": "sysparmQuery",
"type": "object",
"info": "Encoded query used to filter the result set. e.g. { change: 'CHG123456' }",
"required": false,
"schema": {
"title": "sysparmQuery",
"type": "object"
}
},
{
"name": "changeId",
"type": "string",
"info": "Unique identifier of the standard change request to retrieve from the [change_request] table.",
"required": true,
"schema": {
"title": "changeId",
"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": "/getStandardChangeRequestById"
},
"task": true
},
{
"name": "deleteStandardChangeRequestById",
"summary": "Deletes the standard change request identified by the specified sys_id.",
"description": "Deletes the standard change request identified by the specified sys_id.",
"input": [
{
"name": "sysparmQuery",
"type": "object",
"info": "Encoded query used to filter the result set. e.g. { change: 'CHG123456' }",
"required": false,
"schema": {
"title": "sysparmQuery",
"type": "object"
}
},
{
"name": "changeId",
"type": "string",
"info": "Unique identifier of the standard change request to retrieve from the [change_request] table.",
"required": true,
"schema": {
"title": "changeId",
"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": "/deleteStandardChangeRequestById"
},
"task": true
},
{
"name": "getStandardChangeTemplate",
"summary": "Retrieves one or more standard change templates based on the specified criteria.",
"description": "Retrieves one or more standard change templates based on the specified criteria.",
"input": [
{
"name": "sysparmQuery",
"type": "object",
"info": "Encoded query used to filter the result set.",
"required": false,
"schema": {
"title": "sysparmQuery",
"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": "/getStandardChangeTemplate"
},
"task": true
},
{
"name": "getStandardChangeTemplateById",
"summary": "Retrieves the standard change template identified by the specified sys_id.",
"description": "Retrieves the standard change template identified by the specified sys_id.",
"input": [
{
"name": "sysparmQuery",
"type": "object",
"info": "Encoded query used to filter the result set.",
"required": false,
"schema": {
"title": "sysparmQuery",
"type": "object"
}
},
{
"name": "changeId",
"type": "string",
"info": "Unique identifier of the standard change template to retrieve from the [std_change_record_producer] table.",
"required": true,
"schema": {
"title": "changeId",
"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": "/getStandardChangeTemplateById"
},
"task": true
},
{
"name": "changeStandardTemplateById",
"summary": "Creates one standard change request based on an existing standard change template.",
"description": "Creates one standard change request based on an existing standard change template as specified by the passed-in template sys_id. Multiple standard change request creations within a single call is not supported.",
"input": [
{
"name": "standardChangeTemplateId",
"type": "string",
"info": "Unique identifier of the standard change template on which to base the new standard change request (from [std_change_record_producer] table).",
"required": true,
"schema": {
"title": "standardChangeTemplateId",
"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": "/changeStandardTemplateById"
},
"task": true
},
{
"name": "getNormalChangeRequest",
"summary": "Retrieves one or more normal change requests based on the specified criteria",
"description": "Retrieves one or more normal change requests based on the specified criteria",
"input": [
{
"name": "sysparmQuery",
"type": "object",
"info": "Encoded query used to filter the result set.",
"required": false,
"schema": {
"title": "sysparmQuery",
"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": "/getNormalChangeRequest"
},
"task": true
},
{
"name": "getNormalChangeRequestById",
"summary": "Retrieves the normal change request identified by the specified sys_id.",
"description": "Retrieves the normal change request identified by the specified sys_id.",
"input": [
{
"name": "sysparmQuery",
"type": "object",
"info": "Encoded query used to filter the result set. e.g. { change: 'CHG123456' }",
"required": false,
"schema": {
"title": "sysparmQuery",
"type": "object"
}
},
{
"name": "changeId",
"type": "string",
"info": "Unique identifier of the standard change request to retrieve from the [change_request] table.",
"required": true,
"schema": {
"title": "changeId",
"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": "/getNormalChangeRequestById"
},
"task": true
},
{
"name": "createNormalChangeRequest",
"summary": "Creates one normal change request based on the default normal change request record.",
"description": "Creates one normal change request based on the default normal change request record. Multiple normal change request creations within a single call is not supported.",
"input": [
{
"name": "change",
"type": "object",
"info": "The change information to be created",
"required": false,
"schema": {
"title": "change",
"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": "/createNormalChangeRequest"
},
"task": true
},
{
"name": "updateNormalChangeRequestById",
"summary": "Updates one normal change request based on the default normal change request record.",
"description": "Updates one normal change request based on the default normal change request record.",
"input": [
{
"name": "changeId",
"type": "string",
"info": "Unique identifier of the standard change request to retrieve from the [change_request] table.",
"required": true,
"schema": {
"title": "changeId",
"type": "string"
}
},
{
"name": "change",
"type": "object",
"info": "The change information to be created",
"required": false,
"schema": {
"title": "change",
"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": "/updateNormalChangeRequestById"
},
"task": true
},
{
"name": "deleteNormalChangeRequestById",
"summary": "Deletes the normal change request identified by the specified sys_id.",
"description": "Deletes the normal change request identified by the specified sys_id.",
"input": [
{
"name": "sysparmQuery",
"type": "object",
"info": "Encoded query used to filter the result set. e.g. { change: 'CHG123456' }",
"required": false,
"schema": {
"title": "sysparmQuery",
"type": "object"
}
},
{
"name": "changeId",
"type": "string",
"info": "Unique identifier of the standard change request to retrieve from the [change_request] table.",
"required": true,
"schema": {
"title": "changeId",