@itentialopensource/adapter-tmf641_service_ordering_management 1.0.0

package/pronghorn.json

@@ -0,0 +1,1646 @@
+{
+  "id": "@itentialopensource/adapter-tmf641_service_ordering_management",
+  "type": "Adapter",
+  "export": "Tmf641ServiceOrderingManagement",
+  "title": "tmf641_service_ordering_management",
+  "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"
+          }
+        }
+      ],
+      "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": "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": "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": "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"
+          }
+        },
+        {
+          "name": "persistFlag",
+          "type": "boolean",
+          "info": "Whether the input properties should be saved",
+          "required": true
+        }
+      ],
+      "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"
+      },
+      "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": [],
+      "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 IAP database",
+      "description": "Moves entities from an adapter into the IAP 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": "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": "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": true
+    },
+    {
+      "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": true
+    },
+    {
+      "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": true
+    },
+    {
+      "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": true
+    },
+    {
+      "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": true
+    },
+    {
+      "name": "listServiceOrder",
+      "summary": "listServiceOrder",
+      "description": "This operation list or find ServiceOrder entities",
+      "input": [
+        {
+          "name": "fields",
+          "type": "string",
+          "info": "Comma-separated properties to be provided in response: string",
+          "required": false,
+          "schema": {
+            "title": "fields",
+            "type": "string"
+          }
+        },
+        {
+          "name": "offset",
+          "type": "number",
+          "info": "Requested index for start of resources to be provided in response: 123",
+          "required": false,
+          "schema": {
+            "title": "offset",
+            "type": "number"
+          }
+        },
+        {
+          "name": "limit",
+          "type": "number",
+          "info": "Requested number of resources to be provided in response: 123",
+          "required": false,
+          "schema": {
+            "title": "limit",
+            "type": "number"
+          }
+        }
+      ],
+      "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": "/listServiceOrder"
+      },
+      "task": true
+    },
+    {
+      "name": "createServiceOrder",
+      "summary": "createServiceOrder",
+      "description": "This operation creates a ServiceOrder entity.",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The ServiceOrder to be created: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The ServiceOrder to be created"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/createServiceOrder"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveServiceOrder",
+      "summary": "retrieveServiceOrder",
+      "description": "This operation retrieves a ServiceOrder entity. Attribute selection is enabled for all first level attributes.",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "Identifier of the ServiceOrder: string",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "type": "string"
+          }
+        },
+        {
+          "name": "fields",
+          "type": "string",
+          "info": "Comma-separated properties to provide in response: string",
+          "required": false,
+          "schema": {
+            "title": "fields",
+            "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": "/retrieveServiceOrder"
+      },
+      "task": true
+    },
+    {
+      "name": "deleteServiceOrder",
+      "summary": "deleteServiceOrder",
+      "description": "This operation deletes a ServiceOrder entity.",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "Identifier of the ServiceOrder: string",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "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": "/deleteServiceOrder"
+      },
+      "task": true
+    },
+    {
+      "name": "patchServiceOrder",
+      "summary": "patchServiceOrder",
+      "description": "This operation updates partially a ServiceOrder entity.",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "Identifier of the ServiceOrder: string",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "type": "string"
+          }
+        },
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The ServiceOrder to be updated: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The ServiceOrder to be updated"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/patchServiceOrder"
+      },
+      "task": true
+    },
+    {
+      "name": "listCancelServiceOrder",
+      "summary": "listCancelServiceOrder",
+      "description": "This operation list or find CancelServiceOrder entities",
+      "input": [
+        {
+          "name": "fields",
+          "type": "string",
+          "info": "Comma-separated properties to be provided in response: string",
+          "required": false,
+          "schema": {
+            "title": "fields",
+            "type": "string"
+          }
+        },
+        {
+          "name": "offset",
+          "type": "number",
+          "info": "Requested index for start of resources to be provided in response: 123",
+          "required": false,
+          "schema": {
+            "title": "offset",
+            "type": "number"
+          }
+        },
+        {
+          "name": "limit",
+          "type": "number",
+          "info": "Requested number of resources to be provided in response: 123",
+          "required": false,
+          "schema": {
+            "title": "limit",
+            "type": "number"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "type": "array",
+          "items": {
+            "title": "CancelServiceOrder",
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "unique identifier"
+              },
+              "href": {
+                "type": "string",
+                "description": "Hyperlink reference"
+              },
+              "cancellationReason": {
+                "type": "string",
+                "description": "Reason why the order is cancelled."
+              },
+              "completionMessage": {
+                "type": "string",
+                "description": "an optional message describing the completion of the task if it is done as expected or it is denied for a reason (like order in an state of PoNR)."
+              },
+              "effectiveCancellationDate": {
+                "type": "string",
+                "description": "Date when the order is cancelled."
+              },
+              "requestedCancellationDate": {
+                "type": "string",
+                "description": "Date when the submitter wants the order to be cancelled"
+              },
+              "errorMessage": {
+                "title": "ErrorMessage2",
+                "type": "object",
+                "properties": {
+                  "code": {
+                    "type": "string",
+                    "description": "error code"
+                  },
+                  "message": {
+                    "type": "string",
+                    "description": "More details and corrective actions related to the error"
+                  },
+                  "reason": {
+                    "type": "string",
+                    "description": "Explanation of the reason for the error"
+                  },
+                  "referenceError": {
+                    "type": "string",
+                    "description": "URI of documentation describing the error"
+                  },
+                  "status": {
+                    "type": "string",
+                    "description": "error code extension like sys-ABC-2001"
+                  },
+                  "@baseType": {
+                    "type": "string",
+                    "description": "When sub-classing, this defines the super-class"
+                  },
+                  "@schemaLocation": {
+                    "type": "string",
+                    "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+                  },
+                  "@type": {
+                    "type": "string",
+                    "description": "When sub-classing, this defines the sub-class Extensible name"
+                  }
+                }
+              },
+              "serviceOrder": {
+                "title": "ServiceOrder1",
+                "required": [
+                  "id"
+                ],
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "unique identifier"
+                  },
+                  "href": {
+                    "type": "string",
+                    "description": "Hyperlink reference"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Name of the related service order"
+                  },
+                  "@baseType": {
+                    "type": "string",
+                    "description": "When sub-classing, this defines the super-class"
+                  },
+                  "@schemaLocation": {
+                    "type": "string",
+                    "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+                  },
+                  "@type": {
+                    "type": "string",
+                    "description": "When sub-classing, this defines the sub-class Extensible name"
+                  },
+                  "@referredType": {
+                    "type": "string",
+                    "description": "The actual type of the target instance when needed for disambiguation."
+                  }
+                }
+              },
+              "state": {
+                "allOf": [
+                  {
+                    "title": "TaskStateType",
+                    "enum": [
+                      "accepted",
+                      "terminatedWithError",
+                      "inProgress",
+                      "done"
+                    ],
+                    "type": "string",
+                    "description": "Possible values for the state of a task"
+                  },
+                  {
+                    "description": "Possible values for the state of a task"
+                  }
+                ]
+              },
+              "@baseType": {
+                "type": "string",
+                "description": "When sub-classing, this defines the super-class"
+              },
+              "@schemaLocation": {
+                "type": "string",
+                "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+              },
+              "@type": {
+                "type": "string",
+                "description": "When sub-classing, this defines the sub-class Extensible name"
+              }
+            },
+            "description": "Request for cancellation an existing Service order"
+          },
+          "description": ""
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/listCancelServiceOrder"
+      },
+      "task": true
+    },
+    {
+      "name": "createCancelServiceOrder",
+      "summary": "createCancelServiceOrder",
+      "description": "This operation creates a CancelServiceOrder entity.",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The CancelServiceOrder to be created: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The CancelServiceOrder to be created"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/createCancelServiceOrder"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveCancelServiceOrder",
+      "summary": "retrieveCancelServiceOrder",
+      "description": "This operation retrieves a CancelServiceOrder entity. Attribute selection is enabled for all first level attributes.",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "Identifier of the CancelServiceOrder: string",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "type": "string"
+          }
+        },
+        {
+          "name": "fields",
+          "type": "string",
+          "info": "Comma-separated properties to provide in response: string",
+          "required": false,
+          "schema": {
+            "title": "fields",
+            "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": "/retrieveCancelServiceOrder"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToServiceOrderCreateEvent",
+      "summary": "listenToServiceOrderCreateEvent",
+      "description": "Example of a client listener for receiving the notification ServiceOrderCreateEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToServiceOrderCreateEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToServiceOrderAttributeValueChangeEvent",
+      "summary": "listenToServiceOrderAttributeValueChangeEvent",
+      "description": "Example of a client listener for receiving the notification ServiceOrderAttributeValueChangeEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToServiceOrderAttributeValueChangeEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToServiceOrderStateChangeEvent",
+      "summary": "listenToServiceOrderStateChangeEvent",
+      "description": "Example of a client listener for receiving the notification ServiceOrderStateChangeEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToServiceOrderStateChangeEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToServiceOrderDeleteEvent",
+      "summary": "listenToServiceOrderDeleteEvent",
+      "description": "Example of a client listener for receiving the notification ServiceOrderDeleteEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToServiceOrderDeleteEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToServiceOrderInformationRequiredEvent",
+      "summary": "listenToServiceOrderInformationRequiredEvent",
+      "description": "Example of a client listener for receiving the notification ServiceOrderInformationRequiredEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToServiceOrderInformationRequiredEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToServiceOrderMilestoneEvent",
+      "summary": "listenToServiceOrderMilestoneEvent",
+      "description": "Example of a client listener for receiving the notification ServiceOrderMilestoneEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToServiceOrderMilestoneEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToServiceOrderJeopardyEvent",
+      "summary": "listenToServiceOrderJeopardyEvent",
+      "description": "Example of a client listener for receiving the notification ServiceOrderJeopardyEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToServiceOrderJeopardyEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToCancelServiceOrderCreateEvent",
+      "summary": "listenToCancelServiceOrderCreateEvent",
+      "description": "Example of a client listener for receiving the notification CancelServiceOrderCreateEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToCancelServiceOrderCreateEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToCancelServiceOrderStateChangeEvent",
+      "summary": "listenToCancelServiceOrderStateChangeEvent",
+      "description": "Example of a client listener for receiving the notification CancelServiceOrderStateChangeEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToCancelServiceOrderStateChangeEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "listenToCancelServiceOrderInformationRequiredEvent",
+      "summary": "listenToCancelServiceOrderInformationRequiredEvent",
+      "description": "Example of a client listener for receiving the notification CancelServiceOrderInformationRequiredEvent",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "The event data: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "The event data"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/listenToCancelServiceOrderInformationRequiredEvent"
+      },
+      "task": true
+    },
+    {
+      "name": "registerListener",
+      "summary": "registerListener",
+      "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "Data containing the callback endpoint to deliver the information: object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "description": "Data containing the callback endpoint to deliver the information"
+              }
+            ],
+            "definitions": {}
+          }
+        }
+      ],
+      "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": "/registerListener"
+      },
+      "task": true
+    },
+    {
+      "name": "unregisterListener",
+      "summary": "unregisterListener",
+      "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "The id of the registered listener: string",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "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": "/unregisterListener"
+      },
+      "task": true
+    }
+  ],
+  "views": []
+}