@itentialopensource/adapter-algosec_fireflow 0.1.1

package/pronghorn.json

@@ -0,0 +1,1672 @@
+{
+  "id": "@itentialopensource/adapter-algosec_fireflow",
+  "type": "Adapter",
+  "export": "AlgosecFireflow",
+  "title": "Algosec_fireflow",
+  "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": "authenticateUsingPOST",
+      "summary": "User authentication operation",
+      "description": "User authentication operation",
+      "input": [
+        {
+          "name": "authenticationData",
+          "type": "object",
+          "info": "AuthenticationData, passed in JSON format: {\"username\": \"string\", \"password\": \"string\", \"domain\": \"string\"}",
+          "required": true,
+          "schema": {
+            "type": "object",
+            "required": [
+              "password",
+              "username"
+            ],
+            "properties": {
+              "username": {
+                "type": "string",
+                "example": "admin",
+                "description": "User name"
+              },
+              "password": {
+                "type": "string",
+                "example": "pass",
+                "description": "User password"
+              },
+              "domain": {
+                "type": "string",
+                "example": 0,
+                "description": "Domain id"
+              }
+            },
+            "title": "AuthenticationData",
+            "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": "/authenticateUsingPOST"
+      },
+      "task": true
+    },
+    {
+      "name": "calculateWorkOrderUsingPOST",
+      "summary": "Trigger work order calculation for change request",
+      "description": "Trigger work order calculation for change request",
+      "input": [
+        {
+          "name": "changeRequestId",
+          "type": "number",
+          "info": "changeRequestId: 123",
+          "required": true,
+          "schema": {
+            "title": "changeRequestId",
+            "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": "/calculateWorkOrderUsingPOST"
+      },
+      "task": true
+    },
+    {
+      "name": "getWorkOrderCalculationStatusUsingGET",
+      "summary": "Get work order calculation status for change request",
+      "description": "Get work order calculation status for change request",
+      "input": [
+        {
+          "name": "changeRequestId",
+          "type": "number",
+          "info": "changeRequestId: 123",
+          "required": true,
+          "schema": {
+            "title": "changeRequestId",
+            "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": "/getWorkOrderCalculationStatusUsingGET"
+      },
+      "task": true
+    },
+    {
+      "name": "createRuleRemovalRequestUsingPOST",
+      "summary": "Create Rule Removal Change Request",
+      "description": "Create Rule Removal Change Request",
+      "input": [
+        {
+          "name": "ruleRemovalChangeRequest",
+          "type": "object",
+          "info": "RuleRemovalChangeRequest, passed in JSON format\n\nRequired fields: You must include a devices field, with a single device listed.\nMultiple devices are not supported.: {\"template\": \"string\", \"fields\": [{\"name\": \"string\", \"values\": \"array\"}], \"requestActions\": [{\"action\": \"Must be one of [remove, disable]\", \"ruleId\": \"string\"}]}",
+          "required": true,
+          "schema": {
+            "type": "object",
+            "required": [
+              "fields",
+              "requestActions",
+              "template"
+            ],
+            "properties": {
+              "template": {
+                "type": "string"
+              },
+              "fields": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "example": "custom field name"
+                    },
+                    "values": {
+                      "type": "array",
+                      "example": [
+                        "custom field value 1",
+                        "custom field value 2"
+                      ],
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "title": "Fields"
+                }
+              },
+              "requestActions": {
+                "type": "array",
+                "description": "Request actions",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "action": {
+                      "type": "string",
+                      "enum": [
+                        "remove",
+                        "disable"
+                      ]
+                    },
+                    "ruleId": {
+                      "type": "string"
+                    }
+                  },
+                  "title": "RuleRemovalRequestedUnit"
+                }
+              }
+            },
+            "title": "RuleRemovalChangeRequest",
+            "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": "/createRuleRemovalRequestUsingPOST"
+      },
+      "task": true
+    },
+    {
+      "name": "createTrafficChangeRequestUsingPOST",
+      "summary": "Create Traffic Change request",
+      "description": "Create Traffic Change request",
+      "input": [
+        {
+          "name": "trafficChangeRequest",
+          "type": "object",
+          "info": "TrafficChangeRequest, passed in JSON format: {\"template\": \"string\", \"fields\": [{\"name\": \"string\", \"values\": \"array\"}], \"traffic\": [{\"source\": {\"items\": [{\"address\": \"string\", \"fields\": [{\"name\": \"string\", \"values\": \"array\"}]}]}, \"destination\": {\"items\": [{\"address\": \"string\", \"fields\": [{\"name\": \"string\", \"values\": \"array\"}]}]}, \"service\": {\"items\": [{\"service\": \"string\", \"fields\": [{\"name\": \"string\", \"values\": \"array\"}]}]}, \"application\": {\"items\": [{\"name\": \"string\", \"fields\": [{\"name\": \"string\", \"values\": \"array\"}]}]}, \"user\": {\"items\": [{\"name\": \"string\", \"fields\": [{\"name\": \"string\", \"values\": \"array\"}]}]}, \"action\": \"string\", \"natDetails\": {\"source\": \"array\", \"destination\": \"array\", \"port\": \"array\", \"type\": \"Must be one of [Static, Dynamic, None]\"}, \"fields\": [{\"name\": \"string\", \"values\": \"array\"}]}]}",
+          "required": true,
+          "schema": {
+            "type": "object",
+            "required": [
+              "fields",
+              "template",
+              "traffic"
+            ],
+            "properties": {
+              "template": {
+                "type": "string"
+              },
+              "fields": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "example": "custom field name"
+                    },
+                    "values": {
+                      "type": "array",
+                      "example": [
+                        "custom field value 1",
+                        "custom field value 2"
+                      ],
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "title": "Fields"
+                }
+              },
+              "traffic": {
+                "type": "array",
+                "description": "traffic",
+                "items": {
+                  "type": "object",
+                  "required": [
+                    "application",
+                    "destination",
+                    "fields",
+                    "natDetails",
+                    "service",
+                    "source",
+                    "user"
+                  ],
+                  "properties": {
+                    "source": {
+                      "type": "object",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "address": {
+                                "type": "string",
+                                "example": "1.1.1.1"
+                              },
+                              "fields": {
+                                "type": "array",
+                                "items": {
+                                  "type": "object",
+                                  "properties": {
+                                    "name": {
+                                      "type": "string",
+                                      "example": "custom field name"
+                                    },
+                                    "values": {
+                                      "type": "array",
+                                      "example": [
+                                        "custom field value 1",
+                                        "custom field value 2"
+                                      ],
+                                      "items": {
+                                        "type": "string"
+                                      }
+                                    }
+                                  },
+                                  "title": "Fields"
+                                }
+                              }
+                            },
+                            "title": "AddressTrafficItemDetails"
+                          }
+                        }
+                      },
+                      "title": "AddressTrafficFieldDetails"
+                    },
+                    "destination": {
+                      "type": "object",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "address": {
+                                "type": "string",
+                                "example": "1.1.1.1"
+                              },
+                              "fields": {
+                                "type": "array",
+                                "items": {
+                                  "type": "object",
+                                  "properties": {
+                                    "name": {
+                                      "type": "string",
+                                      "example": "custom field name"
+                                    },
+                                    "values": {
+                                      "type": "array",
+                                      "example": [
+                                        "custom field value 1",
+                                        "custom field value 2"
+                                      ],
+                                      "items": {
+                                        "type": "string"
+                                      }
+                                    }
+                                  },
+                                  "title": "Fields"
+                                }
+                              }
+                            },
+                            "title": "AddressTrafficItemDetails"
+                          }
+                        }
+                      },
+                      "title": "AddressTrafficFieldDetails"
+                    },
+                    "service": {
+                      "type": "object",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "service": {
+                                "type": "string",
+                                "example": "tcp/80"
+                              },
+                              "fields": {
+                                "type": "array",
+                                "items": {
+                                  "type": "object",
+                                  "properties": {
+                                    "name": {
+                                      "type": "string",
+                                      "example": "custom field name"
+                                    },
+                                    "values": {
+                                      "type": "array",
+                                      "example": [
+                                        "custom field value 1",
+                                        "custom field value 2"
+                                      ],
+                                      "items": {
+                                        "type": "string"
+                                      }
+                                    }
+                                  },
+                                  "title": "Fields"
+                                }
+                              }
+                            },
+                            "title": "ServiceTrafficItemDetails"
+                          }
+                        }
+                      },
+                      "title": "ServiceTrafficFieldDetails"
+                    },
+                    "application": {
+                      "type": "object",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "name": {
+                                "type": "string",
+                                "example": "name to match"
+                              },
+                              "fields": {
+                                "type": "array",
+                                "items": {
+                                  "type": "object",
+                                  "properties": {
+                                    "name": {
+                                      "type": "string",
+                                      "example": "custom field name"
+                                    },
+                                    "values": {
+                                      "type": "array",
+                                      "example": [
+                                        "custom field value 1",
+                                        "custom field value 2"
+                                      ],
+                                      "items": {
+                                        "type": "string"
+                                      }
+                                    }
+                                  },
+                                  "title": "Fields"
+                                }
+                              }
+                            },
+                            "title": "NameTrafficItemDetails"
+                          }
+                        }
+                      },
+                      "title": "NameTrafficFieldDetails"
+                    },
+                    "user": {
+                      "type": "object",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "name": {
+                                "type": "string",
+                                "example": "name to match"
+                              },
+                              "fields": {
+                                "type": "array",
+                                "items": {
+                                  "type": "object",
+                                  "properties": {
+                                    "name": {
+                                      "type": "string",
+                                      "example": "custom field name"
+                                    },
+                                    "values": {
+                                      "type": "array",
+                                      "example": [
+                                        "custom field value 1",
+                                        "custom field value 2"
+                                      ],
+                                      "items": {
+                                        "type": "string"
+                                      }
+                                    }
+                                  },
+                                  "title": "Fields"
+                                }
+                              }
+                            },
+                            "title": "NameTrafficItemDetails"
+                          }
+                        }
+                      },
+                      "title": "NameTrafficFieldDetails"
+                    },
+                    "action": {
+                      "type": "string",
+                      "example": "Allow/Drop"
+                    },
+                    "natDetails": {
+                      "type": "object",
+                      "properties": {
+                        "source": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        },
+                        "destination": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        },
+                        "port": {
+                          "type": "array",
+                          "items": {
+                            "type": "string"
+                          }
+                        },
+                        "type": {
+                          "type": "string",
+                          "example": "Static/Dynamic",
+                          "enum": [
+                            "Static",
+                            "Dynamic",
+                            "None"
+                          ]
+                        }
+                      },
+                      "title": "NatDetails"
+                    },
+                    "fields": {
+                      "type": "array",
+                      "description": "fields",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "name": {
+                            "type": "string",
+                            "example": "custom field name"
+                          },
+                          "values": {
+                            "type": "array",
+                            "example": [
+                              "custom field value 1",
+                              "custom field value 2"
+                            ],
+                            "items": {
+                              "type": "string"
+                            }
+                          }
+                        },
+                        "title": "Fields"
+                      }
+                    }
+                  },
+                  "title": "TrafficLineDetails"
+                }
+              }
+            },
+            "title": "TrafficChangeRequest",
+            "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": "/createTrafficChangeRequestUsingPOST"
+      },
+      "task": true
+    },
+    {
+      "name": "getTicketUsingGET",
+      "summary": "Get Ticket details by change request id number",
+      "description": "Get Ticket details by change request id number",
+      "input": [
+        {
+          "name": "changeRequestId",
+          "type": "number",
+          "info": "Id of the Change Request: 123",
+          "required": true,
+          "schema": {
+            "title": "changeRequestId",
+            "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": "/getTicketUsingGET"
+      },
+      "task": true
+    },
+    {
+      "name": "updateTrafficChangeRequestCustomFieldsUsingPUT",
+      "summary": "Update Traffic Change request's custom fields",
+      "description": "Update Traffic Change request's custom fields",
+      "input": [
+        {
+          "name": "changeRequestId",
+          "type": "number",
+          "info": "Id of the Change request: 123",
+          "required": true,
+          "schema": {
+            "title": "changeRequestId",
+            "type": "number"
+          }
+        },
+        {
+          "name": "trafficChangeRequestFields",
+          "type": "array",
+          "info": "List of fields, passed in JSON format: array",
+          "required": true,
+          "schema": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "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": "/updateTrafficChangeRequestCustomFieldsUsingPUT"
+      },
+      "task": true
+    },
+    {
+      "name": "calculateActiveChangeUsingPOST",
+      "summary": "Implement work-order recommendations of the given change request, using ActiveChange",
+      "description": "Implement work-order recommendations of the given change request, using ActiveChange",
+      "input": [
+        {
+          "name": "changeRequestId",
+          "type": "number",
+          "info": "changeRequestId: 123",
+          "required": true,
+          "schema": {
+            "title": "changeRequestId",
+            "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": "/calculateActiveChangeUsingPOST"
+      },
+      "task": true
+    },
+    {
+      "name": "getActiveChangeStatusUsingGET",
+      "summary": "Get ActiveChange results of the given change request",
+      "description": "Get ActiveChange results of the given change request",
+      "input": [
+        {
+          "name": "changeRequestId",
+          "type": "number",
+          "info": "changeRequestId: 123",
+          "required": true,
+          "schema": {
+            "title": "changeRequestId",
+            "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": "/getActiveChangeStatusUsingGET"
+      },
+      "task": true
+    },
+    {
+      "name": "createObjectChangeRequestUsingPOST",
+      "summary": "Create Object Change request",
+      "description": "Create Object Change request",
+      "input": [
+        {
+          "name": "objectChangeRequestDetails",
+          "type": "object",
+          "info": "ObjectChangeRequestDetails, passed in JSON format: {\"template\": \"string\", \"fields\": [{\"name\": \"string\", \"values\": \"array\"}], \"subject\": \"string\", \"cc\": \"array\", \"description\": \"string\", \"devices\": \"array\", \"due\": \"string\", \"expire\": \"string\", \"externalId\": \"string\", \"owner\": \"string\", \"priority\": \"string\", \"refersTo\": \"array\", \"referredBy\": \"array\", \"requestor\": \"string\", \"requestedActions\": [{\"devices\": \"array\", \"lineOrder\": 123, \"name\": \"string\", \"objectContainers\": \"array\", \"type\": \"Must be one of [network, service]\", \"valuableServiceObject\": \"boolean\"}], \"objectContainerLevel\": \"Must be one of [Lowest, Highest, Automatic, Invalid]\"}",
+          "required": true,
+          "schema": {
+            "type": "object",
+            "required": [
+              "devices",
+              "fields",
+              "requestedActions",
+              "template"
+            ],
+            "properties": {
+              "template": {
+                "type": "string"
+              },
+              "fields": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "example": "custom field name"
+                    },
+                    "values": {
+                      "type": "array",
+                      "example": [
+                        "custom field value 1",
+                        "custom field value 2"
+                      ],
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "title": "Fields"
+                }
+              },
+              "subject": {
+                "type": "string"
+              },
+              "cc": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "description": {
+                "type": "string"
+              },
+              "devices": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "due": {
+                "type": "string"
+              },
+              "expire": {
+                "type": "string"
+              },
+              "externalId": {
+                "type": "string"
+              },
+              "owner": {
+                "type": "string"
+              },
+              "priority": {
+                "type": "string"
+              },
+              "refersTo": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "referredBy": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "requestor": {
+                "type": "string"
+              },
+              "requestedActions": {
+                "type": "array",
+                "example": [
+                  {
+                    "action": "create",
+                    "name": "string",
+                    "type": "network/service",
+                    "isGroup": "true/false",
+                    "values": [
+                      "string 1",
+                      "string 2"
+                    ]
+                  },
+                  {
+                    "action": "delete",
+                    "name": "string",
+                    "type": "network/service"
+                  },
+                  {
+                    "action": "addObjectsToGroup",
+                    "name": "string",
+                    "type": "network/service",
+                    "values": [
+                      "string 1",
+                      "string 2"
+                    ]
+                  },
+                  {
+                    "action": "removeObjectsFromGroup",
+                    "name": "string",
+                    "type": "network/service",
+                    "values": [
+                      "string 1",
+                      "string 2"
+                    ]
+                  },
+                  {
+                    "action": "replaceContent",
+                    "name": "string",
+                    "type": "network/service",
+                    "values": [
+                      "string 1",
+                      "string 2"
+                    ]
+                  }
+                ],
+                "description": "Requested actions",
+                "items": {
+                  "type": "object",
+                  "discriminator": "action",
+                  "properties": {
+                    "devices": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "lineOrder": {
+                      "type": "integer"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "objectContainers": {
+                      "type": "array",
+                      "items": {
+                        "type": "integer"
+                      }
+                    },
+                    "type": {
+                      "type": "string",
+                      "enum": [
+                        "network",
+                        "service"
+                      ]
+                    },
+                    "valuableServiceObject": {
+                      "type": "boolean"
+                    }
+                  },
+                  "title": "Action"
+                }
+              },
+              "objectContainerLevel": {
+                "type": "string",
+                "example": "Lowest/Highest/Automatic",
+                "description": "Object container level",
+                "enum": [
+                  "Lowest",
+                  "Highest",
+                  "Automatic",
+                  "Invalid"
+                ]
+              }
+            },
+            "title": "ObjectChangeRequestDetails",
+            "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": "/createObjectChangeRequestUsingPOST"
+      },
+      "task": true
+    },
+    {
+      "name": "getSavedSearchByNameProxyUsingGET",
+      "summary": "Find Saved Search results by name",
+      "description": "Find Saved Search results by name",
+      "input": [
+        {
+          "name": "savedSearchName",
+          "type": "string",
+          "info": "Name of Saved Search: string",
+          "required": true,
+          "schema": {
+            "title": "savedSearchName",
+            "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": "/getSavedSearchByNameProxyUsingGET"
+      },
+      "task": true
+    },
+    {
+      "name": "verifySessionStatusUsingGET",
+      "summary": "Checks if a session is alive by entering a session cookie in the request header. This endpoint cann",
+      "description": "Checks if a session is alive by entering a session cookie in the request header. This endpoint cannot be tested from the swagger client. Use other REST clients.",
+      "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": "/verifySessionStatusUsingGET"
+      },
+      "task": true
+    },
+    {
+      "name": "getTemplatesUsingGET",
+      "summary": "List all permitted request templates",
+      "description": "List all permitted request templates",
+      "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": "/getTemplatesUsingGET"
+      },
+      "task": true
+    }
+  ],
+  "views": []
+}