@itentialopensource/adapter-onap_sdc/pronghorn.json

This adapter integrates with system described as: onap_sdc.

{
  "id": "@itentialopensource/adapter-onap_sdc",
  "type": "Adapter",
  "export": "OnapSdc",
  "title": "Onap_sdc",
  "src": "adapter.js",
  "roles": [
    "admin"
  ],
  "methods": [
    {
      "name": "iapUpdateAdapterConfiguration",
      "summary": "Updates the adapter configuration",
      "description": "Updates the adapter configuration file with the provided changes",
      "input": [
        {
          "name": "configFile",
          "type": "string",
          "info": "The name of the file to change",
          "required": true,
          "schema": {
            "title": "configFile",
            "type": "string"
          }
        },
        {
          "name": "changes",
          "type": "object",
          "info": "JSON object containing the configuration changes",
          "required": true,
          "schema": {
            "title": "changes",
            "type": "object"
          }
        },
        {
          "name": "entity",
          "type": "string",
          "info": "The entity in which the changes are being made",
          "required": false,
          "schema": {
            "title": "entity",
            "type": "string"
          }
        },
        {
          "name": "type",
          "type": "string",
          "info": "The type of file to change - action, schema, or mock",
          "required": false,
          "schema": {
            "title": "type",
            "type": "string"
          }
        },
        {
          "name": "action",
          "type": "string",
          "info": "The action to be changed",
          "required": false,
          "schema": {
            "title": "action",
            "type": "string"
          }
        },
        {
          "name" : "replace",
          "type": "boolean",
          "info": "True to replace entire mock data, false to merge/append",
          "required": false,
          "schema": {
            "title": "replace",
            "type" : "boolean"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUpdateAdapterConfiguration"
      },
      "task": true
    },
    {
      "name": "iapSuspendAdapter",
      "summary": "Suspends the adapter",
      "description": "Suspends the adapter",
      "input": [
        {
          "name": "mode",
          "type": "enum",
          "enumerals": [
            "pause",
            "error"
          ],
          "info": "How incoming requests are handled. Defaults to 'pause'",
          "description": "How incoming requests are handled. Defaults to 'pause'",
          "schema": {
            "title": "mode",
            "type": "string"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapSuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapUnsuspendAdapter",
      "summary": "Unsuspends the adapter",
      "description": "Unsuspends the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter suspended status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapUnsuspendAdapter"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterQueue",
      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
      "description": "Return the requests that are waiting in the queue if throttling is enabled",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the adapter queue",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetAdapterQueue"
      },
      "task": true
    },
    {
      "name": "iapFindAdapterPath",
      "summary": "Provides the ability to see if a particular API path is supported by the adapter",
      "description": "Provides the ability to see if a particular API path is supported by the adapter",
      "input": [
        {
          "name": "apiPath",
          "type": "string",
          "info": "The API Path you want to check - make sure to not include base path and version",
          "description": "The API Path you want to check - make sure to not include base path and version",
          "schema": {
            "title": "apiPath",
            "type": "string"
          },
          "required": true
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapFindAdapterPath"
      },
      "task": true
    },
    {
      "name": "iapTroubleshootAdapter",
      "summary": "Runs troubleshoot script for adapter",
      "description": "Runs troubleshoot script for adapter",
      "input": [
        {
          "name": "props",
          "type": "object",
          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
          "required": true,
          "schema": {
            "title": "props",
            "type": "object"
          }
        },
        {
          "name": "persistFlag",
          "type": "boolean",
          "info": "Whether the input properties should be saved",
          "required": true,
          "schema": {
            "title": "persistFlag",
            "type": "boolean"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapTroubleshootAdapter"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterHealthcheck",
      "summary": "Runs healthcheck script for adapter",
      "description": "Runs healthcheck script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "Whether healthcheck passed or failed",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterHealthcheck"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterConnectivity",
      "summary": "Runs connectivity check script for adapter",
      "description": "Runs connectivity check script for adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing the test results",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRunAdapterConnectivity"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterBasicGet",
      "summary": "Runs basicGet script for adapter",
      "description": "Runs basicGet script for adapter",
      "input": [],
      "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": "iapDeactivateTasks",
      "summary": "Deactivate the inputted tasks",
      "description": "Deactivate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to deactivate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapDeactivateTasks"
      },
      "task": true
    },
    {
      "name": "iapActivateTasks",
      "summary": "Activate the inputted tasks",
      "description": "activate the inputted tasks",
      "input": [
        {
          "name": "tasks",
          "type": "array",
          "description": "Tasks to activate",
          "schema": {
            "title": "tasks",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing success status",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapActivateTasks"
      },
      "task": true
    },
    {
      "name": "iapPopulateEntityCache",
      "summary": "Populate the cache for the given entities",
      "description": "Populate the cache for the given entities",
      "input": [
        {
          "name": "entityTypes",
          "type": "array",
          "info": "the entity type(s) to populate",
          "required": true,
          "schema": {
            "title": "entityTypes",
            "type": "array"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapPopulateEntityCache"
      },
      "task": true
    },
    {
      "name": "iapRetrieveEntitiesCache",
      "summary": "Retrieves data from cache for specified entity type",
      "description": "Retrieves data from cache for specified entity type",
      "input": [
        {
          "name": "entityType",
          "type": "string",
          "info": "entity of which to retrieve",
          "required": true,
          "schema": {
            "title": "entityType",
            "type": "string"
          }
        },
        {
          "name": "options",
          "type": "object",
          "info": "settings of which data to return and how to return it",
          "required": false,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapRetrieveEntitiesCache"
      },
      "task": true
    },
    {
      "name": "getDevice",
      "summary": "Get the Appliance",
      "description": "Get the Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevice"
      },
      "task": false
    },
    {
      "name": "getDevicesFiltered",
      "summary": "Get Appliances that match the filter",
      "description": "Get Appliances that match the filter",
      "input": [
        {
          "name": "options",
          "type": "object",
          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
          "required": true,
          "schema": {
            "title": "options",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "array",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "array"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getDevicesFiltered"
      },
      "task": false
    },
    {
      "name": "isAlive",
      "summary": "Checks the status for the provided Appliance",
      "description": "Checks the status for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "boolean",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "boolean"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/isAlive"
      },
      "task": false
    },
    {
      "name": "getConfig",
      "summary": "Gets a config for the provided Appliance",
      "description": "Gets a config for the provided Appliance",
      "input": [
        {
          "name": "deviceName",
          "type": "string",
          "info": "An Appliance Device Name",
          "required": true,
          "schema": {
            "title": "deviceName",
            "type": "string"
          }
        },
        {
          "name": "format",
          "type": "string",
          "info": "The format to be returned - this is ignored as we always return json",
          "required": false,
          "schema": {
            "title": "format",
            "type": "string"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/getConfig"
      },
      "task": false
    },
    {
      "name": "iapGetDeviceCount",
      "summary": "Gets a device count from the system",
      "description": "Gets a device count from the system",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapGetDeviceCount"
      },
      "task": false
    },
    {
      "name": "iapExpandedGenericAdapterRequest",
      "summary": "Makes the requested generic call with additional options",
      "description": "Makes the requested generic call with additional options via metadata",
      "input": [
        {
          "name": "metadata",
          "type": "object",
          "info": "metadata for the call (optional)",
          "description": "metadata for the call - allows for many enhancements (optional)",
          "schema": {
            "title": "metadata",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": false
        },
        {
          "name": "pathVars",
          "type": "object",
          "info": "the parameters to be put within the url path (optional)",
          "description": "the parameters to be put within the url path (optional)",
          "schema": {
            "title": "pathVars",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/iapExpandedGenericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequest",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequest"
      },
      "task": true
    },
    {
      "name": "genericAdapterRequestNoBasePath",
      "summary": "Makes the requested generic call",
      "description": "Makes the requested generic call",
      "input": [
        {
          "name": "uriPath",
          "type": "string",
          "info": "the path of the api call - do not include the host, port, base path or version",
          "description": "the path of the api call",
          "schema": {
            "title": "uriPath",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "restMethod",
          "type": "string",
          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
          "schema": {
            "title": "restMethod",
            "type": "string"
          },
          "required": true
        },
        {
          "name": "queryData",
          "type": "object",
          "info": "the query parameters to be put on the url (optional)",
          "description": "the query parameters to be put on the url (optional)",
          "schema": {
            "title": "queryData",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "requestBody",
          "type": "object",
          "info": "the payload to be sent with the request (optional)",
          "description": "the payload to be sent with the request (optional)",
          "schema": {
            "title": "requestBody",
            "type": "object"
          },
          "required": false
        },
        {
          "name": "addlHeaders",
          "type": "object",
          "info": "additional headers to be put on the call (optional)",
          "description": "additional headers to be put on the call (optional)",
          "schema": {
            "title": "addlHeaders",
            "type": "object"
          },
          "required": false
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/genericAdapterRequestNoBasePath"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterLint",
      "summary": "Run the adapter lint script to return the results",
      "description": "Run the adapter lint script to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "string",
        "description": "A string containing the run results",
        "schema": {
          "title": "result",
          "type": "string"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterLint"
      },
      "task": true
    },
    {
      "name": "iapRunAdapterTests",
      "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
      "description": "Run the adapter test scripts (baseunit and unit) to return the results",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapRunAdapterTests"
      },
      "task": true
    },
    {
      "name": "iapGetAdapterInventory",
      "summary": "Provide inventory information abbout the adapter",
      "description": "Provide inventory information abbout the adapter",
      "input": [],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "GET",
        "path": "/iapGetAdapterInventory"
      },
      "task": true
    },
    {
      "name": "downloadServiceArtifact",
      "summary": "Download service artifact",
      "description": "Returns downloaded artifact",
      "input": [
        {
          "name": "serviceName",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "serviceName",
            "type": "string"
          }
        },
        {
          "name": "serviceVersion",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "serviceVersion",
            "type": "string"
          }
        },
        {
          "name": "artifactName",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "artifactName",
            "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": "/downloadServiceArtifact"
      },
      "task": true
    },
    {
      "name": "downloadResourceInstanceArtifactByName",
      "summary": "Download resource instance artifact",
      "description": "Returns downloaded artifact",
      "input": [
        {
          "name": "serviceName",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "serviceName",
            "type": "string"
          }
        },
        {
          "name": "serviceVersion",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "serviceVersion",
            "type": "string"
          }
        },
        {
          "name": "resourceInstanceName",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "resourceInstanceName",
            "type": "string"
          }
        },
        {
          "name": "artifactName",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "artifactName",
            "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": "/downloadResourceInstanceArtifactByName"
      },
      "task": true
    },
    {
      "name": "downloadResourceArtifact",
      "summary": "Download resource artifact",
      "description": "Returns downloaded artifact",
      "input": [
        {
          "name": "serviceName",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "serviceName",
            "type": "string"
          }
        },
        {
          "name": "serviceVersion",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "serviceVersion",
            "type": "string"
          }
        },
        {
          "name": "resourceName",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "resourceName",
            "type": "string"
          }
        },
        {
          "name": "resourceVersion",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "resourceVersion",
            "type": "string"
          }
        },
        {
          "name": "artifactName",
          "type": "string",
          "info": "",
          "required": true,
          "schema": {
            "title": "artifactName",
            "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": "/downloadResourceArtifact"
      },
      "task": true
    },
    {
      "name": "registerForDistribution",
      "summary": "Subscription status",
      "description": "Subscribes for distribution notifications",
      "input": [
        {
          "name": "requestJson",
          "type": "object",
          "info": "json describe the artifact",
          "required": true,
          "schema": {
            "title": "requestJson",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/registerForDistribution"
      },
      "task": true
    },
    {
      "name": "getValidArtifactTypes",
      "summary": "Artifact types list",
      "description": "Fetches available artifact types list",
      "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": "/getValidArtifactTypes"
      },
      "task": true
    },
    {
      "name": "unRegisterForDistribution",
      "summary": "Subscription status",
      "description": "Removes from subscription for distribution notifications",
      "input": [
        {
          "name": "requestJson",
          "type": "object",
          "info": "json describe the artifact",
          "required": true,
          "schema": {
            "title": "requestJson",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/unRegisterForDistribution"
      },
      "task": true
    },
    {
      "name": "getUebServerList",
      "summary": "UEB Server List",
      "description": "return the available UEB Server List",
      "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": "/getUebServerList"
      },
      "task": true
    },
    {
      "name": "uploadArtifact",
      "summary": "uploads of artifact to a resource or service",
      "description": "uploads of artifact to a resource or service",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "json describe the artifact",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/uploadArtifact"
      },
      "task": true
    },
    {
      "name": "downloadComponentArtifact",
      "summary": "Download component artifact",
      "description": "Returns downloaded artifact",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "artifactUUID",
          "type": "string",
          "info": "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation",
          "required": true,
          "schema": {
            "title": "artifactUUID",
            "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": "/downloadComponentArtifact"
      },
      "task": true
    },
    {
      "name": "updateArtifact",
      "summary": "updates an artifact on a resource or service",
      "description": "uploads of artifact to a resource or service",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "artifactUUID",
          "type": "string",
          "info": "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation",
          "required": true,
          "schema": {
            "title": "artifactUUID",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "json describe the artifact",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateArtifact"
      },
      "task": true
    },
    {
      "name": "deleteArtifact",
      "summary": "deletes an artifact of a resource or service",
      "description": "deletes an artifact of a resource or service",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "artifactUUID",
          "type": "string",
          "info": "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation",
          "required": true,
          "schema": {
            "title": "artifactUUID",
            "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": "/deleteArtifact"
      },
      "task": true
    },
    {
      "name": "uploadArtifactToInstance",
      "summary": "uploads an artifact to a resource instance",
      "description": "uploads an artifact to a resource instance",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "resourceInstanceName",
          "type": "string",
          "info": "The component instance name (as publishedin the response of the detailed query)",
          "required": true,
          "schema": {
            "title": "resourceInstanceName",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "json describe the artifact",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/uploadArtifactToInstance"
      },
      "task": true
    },
    {
      "name": "downloadResourceInstanceArtifact",
      "summary": "Download resource instance artifact",
      "description": "Returns downloaded artifact",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "artifactUUID",
          "type": "string",
          "info": "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation",
          "required": true,
          "schema": {
            "title": "artifactUUID",
            "type": "string"
          }
        },
        {
          "name": "resourceInstanceName",
          "type": "string",
          "info": "The component instance name (as publishedin the response of the detailed query)",
          "required": true,
          "schema": {
            "title": "resourceInstanceName",
            "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": "/downloadResourceInstanceArtifact"
      },
      "task": true
    },
    {
      "name": "updateArtifactOnResourceInstance",
      "summary": "updates an artifact on a resource instance",
      "description": "uploads of artifact to a resource or service",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "artifactUUID",
          "type": "string",
          "info": "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation",
          "required": true,
          "schema": {
            "title": "artifactUUID",
            "type": "string"
          }
        },
        {
          "name": "resourceInstanceName",
          "type": "string",
          "info": "The component instance name (as publishedin the response of the detailed query)",
          "required": true,
          "schema": {
            "title": "resourceInstanceName",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "json describe the artifact",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/updateArtifactOnResourceInstance"
      },
      "task": true
    },
    {
      "name": "deleteArtifactOnResourceInstance",
      "summary": "deletes an artifact of a resource insatnce",
      "description": "deletes an artifact of a resource insatnce",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "artifactUUID",
          "type": "string",
          "info": "The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation",
          "required": true,
          "schema": {
            "title": "artifactUUID",
            "type": "string"
          }
        },
        {
          "name": "resourceInstanceName",
          "type": "string",
          "info": "The component instance name (as publishedin the response of the detailed query)",
          "required": true,
          "schema": {
            "title": "resourceInstanceName",
            "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": "/deleteArtifactOnResourceInstance"
      },
      "task": true
    },
    {
      "name": "uploadInterfaceOperationArtifact",
      "summary": "uploads of artifact to VF operation workflow",
      "description": "uploads of artifact to VF operation workflow",
      "input": [
        {
          "name": "uuid",
          "type": "string",
          "info": "The uuid of the asset as published in the metadata",
          "required": true,
          "schema": {
            "title": "uuid",
            "type": "string"
          }
        },
        {
          "name": "operationUUID",
          "type": "string",
          "info": "The uuid of the operation",
          "required": true,
          "schema": {
            "title": "operationUUID",
            "type": "string"
          }
        },
        {
          "name": "artifactUUID",
          "type": "string",
          "info": "The uuid of the artifact",
          "required": true,
          "schema": {
            "title": "artifactUUID",
            "type": "string"
          }
        },
        {
          "name": "body",
          "type": "object",
          "info": "json describe the artifact",
          "required": true,
          "schema": {
            "title": "body",
            "type": "object"
          }
        }
      ],
      "output": {
        "name": "result",
        "type": "object",
        "description": "A JSON Object containing status, code and the result",
        "schema": {
          "title": "result",
          "type": "object"
        }
      },
      "roles": [
        "admin"
      ],
      "route": {
        "verb": "POST",
        "path": "/uploadInterfaceOperationArtifact"
      },
      "task": true
    },
    {
      "name": "getAssetListExternal",
      "summary": "Fetch list of assets",
      "description": "Returns list of assets",
      "input": [
        {
          "name": "assetType",
          "type": "string",
          "info": "The requested asset type",
          "required": true,
          "schema": {
            "title": "assetType",
            "type": "string"
          }
        },
        {
          "name": "category",
          "type": "string",
          "info": "The filter key (resourceType only for resources)",
          "required": false,
          "schema": {