@itentialopensource/adapter-onap_aai

{ "id": "@itentialopensource/adapter-onap_aai", "type": "Adapter", "export": "OnapAai", "title": "Onap_aai", "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": "createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "targetPe", "type": "string", "info": "The Target provider edge router", "required": true, "schema": { "title": "targetPe", "type": "string" } }, { "name": "availabilityZoneName", "type": "string", "info": "Name of the availability zone", "required": true, "schema": { "title": "availabilityZoneName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPo...(description truncated)", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "targetPe", "type": "string", "info": "The Target provider edge router", "required": true, "schema": { "title": "targetPe", "type": "string" } }, { "name": "availabilityZoneName", "type": "string", "info": "Name of the availability zone", "required": true, "schema": { "title": "availabilityZoneName", "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": "/deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureComplexesComplexCtagPoolsCtagPool", "summary": "returns ctag-pool", "description": "returns ctag-pool", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "targetPe", "type": "string", "info": "The Target provider edge router", "required": true, "schema": { "title": "targetPe", "type": "string" } }, { "name": "availabilityZoneName", "type": "string", "info": "Name of the availability zone", "required": true, "schema": { "title": "availabilityZoneName", "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": "/getCloudInfrastructureComplexesComplexCtagPoolsCtagPool" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool", "summary": "create or update an existing ctag-pool", "description": "Create or update an existing ctag-pool.\n#\nNote! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "targetPe", "type": "string", "info": "The Target provider edge router", "required": true, "schema": { "title": "targetPe", "type": "string" } }, { "name": "availabilityZoneName", "type": "string", "info": "Name of the availability zone", "required": true, "schema": { "title": "availabilityZoneName", "type": "string" } }, { "name": "body", "type": "object", "info": "ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool....(description truncated)", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool" }, "task": true }, { "name": "updateCloudInfrastructureComplexesComplexCtagPoolsCtagPool", "summary": "update an existing ctag-pool", "description": "Update an existing ctag-pool\n#\nNote: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.\nThe PUT operation will entirely replace an existing object.\nThe PATCH operation sends a \"description of changes\" for an existing object. The entire set of changes must be applied. An error result means no change occurs.\n#\nOther differences between PUT and PATCH are:\n#\n- For PATCH, you can send any of the values shown in sample REQUEST body. There are no required ...(description truncated)", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "targetPe", "type": "string", "info": "The Target provider edge router", "required": true, "schema": { "title": "targetPe", "type": "string" } }, { "name": "availabilityZoneName", "type": "string", "info": "Name of the availability zone", "required": true, "schema": { "title": "availabilityZoneName", "type": "string" } }, { "name": "body", "type": "object", "info": "ctag-pool object that needs to be updated.", "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": "/updateCloudInfrastructureComplexesComplexCtagPoolsCtagPool" }, "task": true }, { "name": "deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool", "summary": "delete an existing ctag-pool", "description": "delete an existing ctag-pool", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "targetPe", "type": "string", "info": "The Target provider edge router", "required": true, "schema": { "title": "targetPe", "type": "string" } }, { "name": "availabilityZoneName", "type": "string", "info": "Name of the availability zone", "required": true, "schema": { "title": "availabilityZoneName", "type": "string" } }, { "name": "resourceVersion", "type": "string", "info": "resource-version for concurrency", "required": true, "schema": { "title": "resourceVersion", "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": "/deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool" }, "task": true }, { "name": "getCloudInfrastructureComplexesComplexCtagPools", "summary": "returns ctag-pools", "description": "returns ctag-pools", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "availabilityZoneName", "type": "string", "info": "", "required": false, "schema": { "title": "availabilityZoneName", "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": "/getCloudInfrastructureComplexesComplexCtagPools" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json)", "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": "/createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureComplexesComplexRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "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": "/deleteCloudInfrastructureComplexesComplexRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureComplexesComplex", "summary": "returns complex", "description": "returns complex", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "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": "/getCloudInfrastructureComplexesComplex" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureComplexesComplex", "summary": "create or update an existing complex", "description": "Create or update an existing complex.\n#\nNote! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "body", "type": "object", "info": "complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json)", "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": "/createOrUpdateCloudInfrastructureComplexesComplex" }, "task": true }, { "name": "updateCloudInfrastructureComplexesComplex", "summary": "update an existing complex", "description": "Update an existing complex\n#\nNote: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.\nThe PUT operation will entirely replace an existing object.\nThe PATCH operation sends a \"description of changes\" for an existing object. The entire set of changes must be applied. An error result means no change occurs.\n#\nOther differences between PUT and PATCH are:\n#\n- For PATCH, you can send any of the values shown in sample REQUEST body. There are no required va...(description truncated)", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "body", "type": "object", "info": "complex object that needs to be updated.", "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": "/updateCloudInfrastructureComplexesComplex" }, "task": true }, { "name": "deleteCloudInfrastructureComplexesComplex", "summary": "delete an existing complex", "description": "delete an existing complex", "input": [ { "name": "physicalLocationId", "type": "string", "info": "Unique identifier for physical location, e.g., CLLI", "required": true, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "resourceVersion", "type": "string", "info": "resource-version for concurrency", "required": true, "schema": { "title": "resourceVersion", "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": "/deleteCloudInfrastructureComplexesComplex" }, "task": true }, { "name": "getCloudInfrastructureComplexes", "summary": "returns complexes", "description": "returns complexes", "input": [ { "name": "physicalLocationId", "type": "string", "info": "", "required": false, "schema": { "title": "physicalLocationId", "type": "string" } }, { "name": "dataCenterCode", "type": "string", "info": "", "required": false, "schema": { "title": "dataCenterCode", "type": "string" } }, { "name": "complexName", "type": "string", "info": "", "required": false, "schema": { "title": "complexName", "type": "string" } }, { "name": "identityUrl", "type": "string", "info": "", "required": false, "schema": { "title": "identityUrl", "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": "/getCloudInfrastructureComplexes" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "cloudOwner", "type": "string", "info": "Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname", "required": true, "schema": { "title": "cloudOwner", "type": "string" } }, { "name": "cloudRegionId", "type": "string", "info": "Identifier used by the vendor for the region. Second part of composite key", "required": true, "schema": { "title": "cloudRegionId", "type": "string" } }, { "name": "volumeGroupId", "type": "string", "info": "Unique ID of volume-group.", "required": true, "schema": { "title": "volumeGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGr...(description truncated)", "required": true, "schema": { "title": "body", "type": "object"