{ "id": "@itentialopensource/adapter-onap_so", "type": "Adapter", "export": "OnapSo", "title": "Onap_so", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "createE2EServiceInstance", "summary": "Create an E2E Service Instance on a version provided", "description": "Create an E2E Service Instance on a version provided", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/createE2EServiceInstance" }, "task": true }, { "name": "updateE2EServiceInstance", "summary": "Update an E2E Service Instance on a version provided and serviceId", "description": "Update an E2E Service Instance on a version provided and serviceId", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceId", "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": "/updateE2EServiceInstance" }, "task": true }, { "name": "deleteE2EServiceInstance", "summary": "Delete E2E Service Instance on a specified version and serviceId", "description": "Delete E2E Service Instance on a specified version and serviceId", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceId", "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": "/deleteE2EServiceInstance" }, "task": true }, { "name": "getE2EServiceInstances", "summary": "Find e2eServiceInstances Requests for a given serviceId and operationId", "description": "Find e2eServiceInstances Requests for a given serviceId and operationId", "input": [ { "name": "serviceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "operationId", "type": "string", "info": "", "required": true, "schema": { "title": "operationId", "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": "/getE2EServiceInstances" }, "task": true }, { "name": "scaleE2EServiceInstance", "summary": "Scale E2E Service Instance on a specified version", "description": "Scale E2E Service Instance on a specified version", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceId", "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": "/scaleE2EServiceInstance" }, "task": true }, { "name": "compareModelwithTargetVersion", "summary": "Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId", "description": "Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "serviceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/compareModelwithTargetVersion" }, "task": true }, { "name": "globalHealthcheck", "summary": "Performing global health check", "description": "Performing global health check", "input": [ { "name": "enableBpmn", "type": "boolean", "info": "", "required": false, "schema": { "title": "enableBpmn", "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": "/globalHealthcheck" }, "task": true }, { "name": "nodeHealthcheck", "summary": "Performing node health check", "description": "Performing node health check", "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": "/nodeHealthcheck" }, "task": true }, { "name": "getOrchestrationRequest", "summary": "Find Orchestrated Requests for a URI Information", "description": "Find Orchestrated Requests for a URI Information", "input": [ { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/getOrchestrationRequest" }, "task": true }, { "name": "getOrchestrationRequestForReqId", "summary": "Find Orchestrated Requests for a given requestId", "description": "Find Orchestrated Requests for a given requestId", "input": [ { "name": "requestId", "type": "string", "info": "", "required": true, "schema": { "title": "requestId", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/getOrchestrationRequestForReqId" }, "task": true }, { "name": "unlockOrchestrationRequest", "summary": "Unlock Orchestrated Requests for a given requestId", "description": "Unlock Orchestrated Requests for a given requestId", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "requestId", "type": "string", "info": "", "required": true, "schema": { "title": "requestId", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/unlockOrchestrationRequest" }, "task": true }, { "name": "deactivateAndCloudDeleteVfModuleInstance", "summary": "Deactivate and Cloud Delete VfModule instance", "description": "Deactivate and Cloud Delete VfModule instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "type": "string" } }, { "name": "vfmoduleInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vfmoduleInstanceId", "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": "/deactivateAndCloudDeleteVfModuleInstance" }, "task": true }, { "name": "enablePort", "summary": "Enable Port Mirroring", "description": "Enable Port Mirroring", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "configurationInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "configurationInstanceId", "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": "/enablePort" }, "task": true }, { "name": "disablePort", "summary": "Disable Port Mirroring", "description": "Disable Port Mirroring", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "configurationInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "configurationInstanceId", "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": "/disablePort" }, "task": true }, { "name": "activatePort", "summary": "Activate Port Mirroring", "description": "Activate Port Mirroring", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "configurationInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "configurationInstanceId", "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": "/activatePort" }, "task": true }, { "name": "deactivatePort", "summary": "Deactivate Port Mirroring", "description": "Deactivate Port Mirroring", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "configurationInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "configurationInstanceId", "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": "/deactivatePort" }, "task": true }, { "name": "addRelationships", "summary": "Add Relationships to a Service Instance", "description": "Add Relationships to a Service Instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/addRelationships" }, "task": true }, { "name": "scaleOutVfModule", "summary": "VF Auto Scale Out", "description": "VF Auto Scale Out", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "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": "/scaleOutVfModule" }, "task": true }, { "name": "inPlaceSoftwareUpdate", "summary": "Perform VNF software update", "description": "Perform VNF software update", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "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": "/inPlaceSoftwareUpdate" }, "task": true }, { "name": "applyUpdatedConfig", "summary": "Apply updated configuration", "description": "Apply updated configuration", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "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": "/applyUpdatedConfig" }, "task": true }, { "name": "createServiceInstance", "summary": "Create a Service Instance on a version provided", "description": "Create a Service Instance on a version provided", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/createServiceInstance" }, "task": true }, { "name": "activateServiceInstance", "summary": "Activate provided Service Instance", "description": "Activate provided Service Instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/activateServiceInstance" }, "task": true }, { "name": "deactivateServiceInstance", "summary": "Deactivate provided Service Instance", "description": "Deactivate provided Service Instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/deactivateServiceInstance" }, "task": true }, { "name": "deleteServiceInstance", "summary": "Delete provided Service Instance", "description": "Delete provided Service Instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/deleteServiceInstance" }, "task": true }, { "name": "assignServiceInstance", "summary": "Assign Service Instance", "description": "Assign Service Instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/assignServiceInstance" }, "task": true }, { "name": "unassignServiceInstance", "summary": "Unassign Service Instance", "description": "Unassign Service Instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/unassignServiceInstance" }, "task": true }, { "name": "createPortConfiguration", "summary": "Create Port Mirroring Configuration", "description": "Create Port Mirroring Configuration", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/createPortConfiguration" }, "task": true }, { "name": "deletePortConfiguration", "summary": "Delete provided Port", "description": "Delete provided Port", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "configurationInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "configurationInstanceId", "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": "/deletePortConfiguration" }, "task": true }, { "name": "removeRelationships", "summary": "Remove Relationships from Service Instance", "description": "Remove Relationships from Service Instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/removeRelationships" }, "task": true }, { "name": "createVnfInstance", "summary": "Create VNF on a specified version and serviceInstance", "description": "Create VNF on a specified version and serviceInstance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/createVnfInstance" }, "task": true }, { "name": "replaceVnfInstance", "summary": "Replace provided VNF instance", "description": "Replace provided VNF instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "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": "/replaceVnfInstance" }, "task": true }, { "name": "updateVnfInstance", "summary": "Update VNF on a specified version, serviceInstance and vnfInstance", "description": "Update VNF on a specified version, serviceInstance and vnfInstance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "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": "/updateVnfInstance" }, "task": true }, { "name": "deleteVnfInstance", "summary": "Delete provided VNF instance", "description": "Delete provided VNF instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "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": "/deleteVnfInstance" }, "task": true }, { "name": "createVfModuleInstance", "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance", "description": "Create VfModule on a specified version, serviceInstance and vnfInstance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "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": "/createVfModuleInstance" }, "task": true }, { "name": "replaceVfModuleInstance", "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance", "description": "Create VfModule on a specified version, serviceInstance and vnfInstance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "type": "string" } }, { "name": "vfmoduleInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vfmoduleInstanceId", "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": "/replaceVfModuleInstance" }, "task": true }, { "name": "updateVfModuleInstance", "summary": "Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule", "description": "Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "type": "string" } }, { "name": "vfmoduleInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vfmoduleInstanceId", "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": "/updateVfModuleInstance" }, "task": true }, { "name": "deleteVfModuleInstance", "summary": "Delete provided VfModule instance", "description": "Delete provided VfModule instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "type": "string" } }, { "name": "vfmoduleInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vfmoduleInstanceId", "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": "/deleteVfModuleInstance" }, "task": true }, { "name": "createVolumeGroupInstance", "summary": "Create VolumeGroup on a specified version, serviceInstance, vnfInstance", "description": "Create VolumeGroup on a specified version, serviceInstance, vnfInstance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "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": "/createVolumeGroupInstance" }, "task": true }, { "name": "updateVolumeGroupInstance", "summary": "Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup", "description": "Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "type": "string" } }, { "name": "volumeGroupInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "volumeGroupInstanceId", "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": "/updateVolumeGroupInstance" }, "task": true }, { "name": "deleteVolumeGroupInstance", "summary": "Delete provided VolumeGroup instance", "description": "Delete provided VolumeGroup instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "vnfInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "vnfInstanceId", "type": "string" } }, { "name": "volumeGroupInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "volumeGroupInstanceId", "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": "/deleteVolumeGroupInstance" }, "task": true }, { "name": "createNetworkInstance", "summary": "Create NetworkInstance on a specified version and serviceInstance", "description": "Create NetworkInstance on a specified version and serviceInstance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "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": "/createNetworkInstance" }, "task": true }, { "name": "updateNetworkInstance", "summary": "Update VolumeGroup on a specified version, serviceInstance, networkInstance", "description": "Update VolumeGroup on a specified version, serviceInstance, networkInstance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "networkInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "networkInstanceId", "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": "/updateNetworkInstance" }, "task": true }, { "name": "deleteNetworkInstance", "summary": "Delete provided Network instance", "description": "Delete provided Network instance", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "networkInstanceId", "type": "string", "info": "", "required": true, "schema": { "title": "networkInstanceId", "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": "/deleteNetworkInstance" }, "task": true }, { "name": "queryFilters", "summary": "Finds Manual Tasks", "description": "Finds Manual Tasks", "input": [ { "name": "taskId", "type": "string", "info": "", "required": false, "schema": { "title": "taskId", "type": "string" } }, { "name": "originalRequestId", "type": "string", "info": "", "required": false, "schema": { "title": "originalRequestId", "type": "string" } }, { "name": "subscriptionServiceType", "type": "string", "info": "", "required": false, "schema": { "title": "subscriptionServiceType", "type": "string" } }, { "name": "nfRole", "type": "string", "info": "", "required": false, "schema": { "title": "nfRole", "type": "string" } }, { "name": "buildingBlockName", "type": "string", "info": "", "required": false, "schema": { "title": "buildingBlockName", "type": "string" } }, { "name": "originalRequestDate", "type": "string", "info": "", "required": false, "schema": { "title": "originalRequestDate", "type": "string" } }, { "name": "originalRequestorId", "type": "string", "info": "", "required": false, "schema": { "title": "originalRequestorId", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/queryFilters" }, "task": true }, { "name": "createOperationEnvironment", "summary": "Create an Operational Environment", "description": "Create an Operational Environment", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/createOperationEnvironment" }, "task": true }, { "name": "activateOperationEnvironment", "summary": "Activate an Operational Environment", "description": "Activate an Operational Environment", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "operationalEnvironmentId", "type": "string", "info": "", "required": true, "schema": { "title": "operationalEnvironmentId", "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": "/activateOperationEnvironment" }, "task": true }, { "name": "deactivateOperationEnvironment", "summary": "Deactivate an Operational Environment", "description": "Deactivate an Operational Environment", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "operationalEnvironmentId", "type": "string", "info": "", "required": true, "schema": { "title": "operationalEnvironmentId", "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": "/deactivateOperationEnvironment" }, "task": true }, { "name": "unlockOrchestrationRequestForReqId", "summary": "Unlock CloudOrchestration requests for a specified requestId", "description": "Unlock CloudOrchestration requests for a specified requestId", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "requestId", "type": "string", "info": "", "required": true, "schema": { "title": "requestId", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/unlockOrchestrationRequestForReqId" }, "task": true }, { "name": "getOperationEnvironmentStatusFilter", "summary": "Get status of an Operational Environment based on filter criteria", "description": "Get status of an Operational Environment based on filter criteria", "input": [ { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "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": "/getOperationEnvironmentStatusFilter" }, "task": true }, { "name": "updateModelDistributionStatus", "summary": "Update model distribution status", "description": "Update model distribution status", "input": [ { "name": "body", "type": "string", "info": "", "required": false, "schema": { "title": "body", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": true, "schema": { "title": "version", "type": "string" } }, { "name": "distributionId", "type": "string", "info": "", "required": true, "schema": { "title": "distributionId", "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": "/updateModelDistributionStatus" }, "task": true } ] }