{ "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" } } ], "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": "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" } } ], "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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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" } } ], "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup", "summary": "returns volume-group", "description": "returns volume-group", "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" } } ], "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": "/getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup", "summary": "create or update an existing volume-group", "description": "Create or update an existing volume-group.\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": "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": "volume-group 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" } } ], "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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup", "summary": "update an existing volume-group", "description": "Update an existing volume-group\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 requir...(description truncated)", "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": "volume-group 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": "/updateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup", "summary": "delete an existing volume-group", "description": "delete an existing volume-group", "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": "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups", "summary": "returns volume-groups", "description": "returns volume-groups", "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": "", "required": false, "schema": { "title": "volumeGroupId", "type": "string" } }, { "name": "volumeGroupName", "type": "string", "info": "", "required": false, "schema": { "title": "volumeGroupName", "type": "string" } }, { "name": "heatStackId", "type": "string", "info": "", "required": false, "schema": { "title": "heatStackId", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "", "required": false, "schema": { "title": "vnfType", "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": "/getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "Unique ID of block storage volume relative to the vserver.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "Unique ID of block storage volume relative to the vserver.", "required": true, "schema": { "title": "volumeId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume", "summary": "returns volume", "description": "returns volume", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "Unique ID of block storage volume relative to the vserver.", "required": true, "schema": { "title": "volumeId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume", "summary": "create or update an existing volume", "description": "Create or update an existing volume.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "Unique ID of block storage volume relative to the vserver.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "body", "type": "object", "info": "volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantV...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume", "summary": "update an existing volume", "description": "Update an existing volume\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 val...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "Unique ID of block storage volume relative to the vserver.", "required": true, "schema": { "title": "volumeId", "type": "string" } }, { "name": "body", "type": "object", "info": "volume 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume", "summary": "delete an existing volume", "description": "delete an existing volume", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "Unique ID of block storage volume relative to the vserver.", "required": true, "schema": { "title": "volumeId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes", "summary": "returns volumes", "description": "returns volumes", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "volumeId", "type": "string", "info": "", "required": false, "schema": { "title": "volumeId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsC...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsC...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVse...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenan...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsC...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsC...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTe...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver", "summary": "returns vserver", "description": "returns vserver", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver", "summary": "create or update an existing vserver", "description": "Create or update an existing vserver.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "body", "type": "object", "info": "vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver", "summary": "update an existing vserver", "description": "Update an existing vserver\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "type": "string" } }, { "name": "body", "type": "object", "info": "vserver 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver", "summary": "delete an existing vserver", "description": "delete an existing vserver", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "Unique identifier for this vserver relative to its tenant", "required": true, "schema": { "title": "vserverId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers", "summary": "returns vservers", "description": "returns vservers", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vserverId", "type": "string", "info": "", "required": false, "schema": { "title": "vserverId", "type": "string" } }, { "name": "vserverName", "type": "string", "info": "", "required": false, "schema": { "title": "vserverName", "type": "string" } }, { "name": "vserverName2", "type": "string", "info": "", "required": false, "schema": { "title": "vserverName2", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "inMaint", "type": "boolean", "info": "", "required": false, "schema": { "title": "inMaint", "type": "boolean" } }, { "name": "isClosedLoopDisabled", "type": "boolean", "info": "", "required": false, "schema": { "title": "isClosedLoopDisabled", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServerRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "nosServerId", "type": "string", "info": "Unique identifier for this nos relative to its tenant", "required": true, "schema": { "title": "nosServerId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServerRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServerRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "nosServerId", "type": "string", "info": "Unique identifier for this nos relative to its tenant", "required": true, "schema": { "title": "nosServerId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServerRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer", "summary": "returns nos-server", "description": "returns nos-server", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "nosServerId", "type": "string", "info": "Unique identifier for this nos relative to its tenant", "required": true, "schema": { "title": "nosServerId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer", "summary": "create or update an existing nos-server", "description": "Create or update an existing nos-server.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "nosServerId", "type": "string", "info": "Unique identifier for this nos relative to its tenant", "required": true, "schema": { "title": "nosServerId", "type": "string" } }, { "name": "body", "type": "object", "info": "nos-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTen...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer", "summary": "update an existing nos-server", "description": "Update an existing nos-server\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "nosServerId", "type": "string", "info": "Unique identifier for this nos relative to its tenant", "required": true, "schema": { "title": "nosServerId", "type": "string" } }, { "name": "body", "type": "object", "info": "nos-server 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer", "summary": "delete an existing nos-server", "description": "delete an existing nos-server", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "nosServerId", "type": "string", "info": "Unique identifier for this nos relative to its tenant", "required": true, "schema": { "title": "nosServerId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServers", "summary": "returns nos-servers", "description": "returns nos-servers", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "nosServerId", "type": "string", "info": "", "required": false, "schema": { "title": "nosServerId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServers" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsT...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant", "summary": "returns tenant", "description": "returns tenant", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant", "summary": "create or update an existing tenant", "description": "Create or update an existing tenant.\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": "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "body", "type": "object", "info": "tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant....(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant", "summary": "update an existing tenant", "description": "Update an existing tenant\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 val...(description truncated)", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "type": "string" } }, { "name": "body", "type": "object", "info": "tenant 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": "/updateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant", "summary": "delete an existing tenant", "description": "delete an existing tenant", "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": "tenantId", "type": "string", "info": "Unique id relative to the cloud-region.", "required": true, "schema": { "title": "tenantId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionTenants", "summary": "returns tenants", "description": "returns tenants", "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": "tenantId", "type": "string", "info": "", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenantName", "type": "string", "info": "", "required": false, "schema": { "title": "tenantName", "type": "string" } }, { "name": "tenantContext", "type": "string", "info": "", "required": false, "schema": { "title": "tenantContext", "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": "/getCloudInfrastructureCloudRegionsCloudRegionTenants" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsF...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsF...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes", "summary": "returns hpa-feature-attributes", "description": "returns hpa-feature-attributes", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "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": "/getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes", "summary": "create or update an existing hpa-feature-attributes", "description": "Create or update an existing hpa-feature-attributes.\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": "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegi...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes", "summary": "update an existing hpa-feature-attributes", "description": "Update an existing hpa-feature-attributes\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...(description truncated)", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-feature-attributes 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": "/updateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes", "summary": "delete an existing hpa-feature-attributes", "description": "delete an existing hpa-feature-attributes", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability", "summary": "returns hpa-capability", "description": "returns hpa-capability", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability", "summary": "create or update an existing hpa-capability", "description": "Create or update an existing hpa-capability.\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": "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavor...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability", "summary": "update an existing hpa-capability", "description": "Update an existing hpa-capability\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 requ...(description truncated)", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-capability 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": "/updateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability", "summary": "delete an existing hpa-capability", "description": "delete an existing hpa-capability", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities", "summary": "returns hpa-capabilities", "description": "returns hpa-capabilities", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "hpaCapabilityId", "type": "string", "info": "", "required": false, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaFeature", "type": "string", "info": "", "required": false, "schema": { "title": "hpaFeature", "type": "string" } }, { "name": "architecture", "type": "string", "info": "", "required": false, "schema": { "title": "architecture", "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": "/getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsF...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor", "summary": "returns flavor", "description": "returns flavor", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor", "summary": "create or update an existing flavor", "description": "Create or update an existing flavor.\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": "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "body", "type": "object", "info": "flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor....(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor", "summary": "update an existing flavor", "description": "Update an existing flavor\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 val...(description truncated)", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "body", "type": "object", "info": "flavor 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": "/updateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor", "summary": "delete an existing flavor", "description": "delete an existing flavor", "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": "flavorId", "type": "string", "info": "Flavor id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "flavorId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionFlavors", "summary": "returns flavors", "description": "returns flavors", "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": "flavorId", "type": "string", "info": "", "required": false, "schema": { "title": "flavorId", "type": "string" } }, { "name": "flavorName", "type": "string", "info": "", "required": false, "schema": { "title": "flavorName", "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": "/getCloudInfrastructureCloudRegionsCloudRegionFlavors" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship", "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": "groupId", "type": "string", "info": "Group id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionGroupAss...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "groupId", "type": "string", "info": "Group id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "groupId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment", "summary": "returns group-assignment", "description": "returns group-assignment", "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": "groupId", "type": "string", "info": "Group id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "groupId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment", "summary": "create or update an existing group-assignment", "description": "Create or update an existing group-assignment.\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": "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": "groupId", "type": "string", "info": "Group id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "body", "type": "object", "info": "group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionGrou...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment", "summary": "update an existing group-assignment", "description": "Update an existing group-assignment\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 re...(description truncated)", "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": "groupId", "type": "string", "info": "Group id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "body", "type": "object", "info": "group-assignment 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": "/updateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment", "summary": "delete an existing group-assignment", "description": "delete an existing group-assignment", "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": "groupId", "type": "string", "info": "Group id, expected to be unique across cloud-region.", "required": true, "schema": { "title": "groupId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments", "summary": "returns group-assignments", "description": "returns group-assignments", "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": "groupId", "type": "string", "info": "", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupType", "type": "string", "info": "", "required": false, "schema": { "title": "groupType", "type": "string" } }, { "name": "groupName", "type": "string", "info": "", "required": false, "schema": { "title": "groupName", "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": "/getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship", "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": "snapshotId", "type": "string", "info": "Snapshot id, this is the key UUID assoc associated in glance with the snapshots.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionSnapshot...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "snapshotId", "type": "string", "info": "Snapshot id, this is the key UUID assoc associated in glance with the snapshots.", "required": true, "schema": { "title": "snapshotId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot", "summary": "returns snapshot", "description": "returns snapshot", "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": "snapshotId", "type": "string", "info": "Snapshot id, this is the key UUID assoc associated in glance with the snapshots.", "required": true, "schema": { "title": "snapshotId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot", "summary": "create or update an existing snapshot", "description": "Create or update an existing snapshot.\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": "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": "snapshotId", "type": "string", "info": "Snapshot id, this is the key UUID assoc associated in glance with the snapshots.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "body", "type": "object", "info": "snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSna...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot", "summary": "update an existing snapshot", "description": "Update an existing snapshot\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 v...(description truncated)", "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": "snapshotId", "type": "string", "info": "Snapshot id, this is the key UUID assoc associated in glance with the snapshots.", "required": true, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "body", "type": "object", "info": "snapshot 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": "/updateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot", "summary": "delete an existing snapshot", "description": "delete an existing snapshot", "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": "snapshotId", "type": "string", "info": "Snapshot id, this is the key UUID assoc associated in glance with the snapshots.", "required": true, "schema": { "title": "snapshotId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionSnapshots", "summary": "returns snapshots", "description": "returns snapshots", "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": "snapshotId", "type": "string", "info": "", "required": false, "schema": { "title": "snapshotId", "type": "string" } }, { "name": "snapshotName", "type": "string", "info": "", "required": false, "schema": { "title": "snapshotName", "type": "string" } }, { "name": "application", "type": "string", "info": "", "required": false, "schema": { "title": "application", "type": "string" } }, { "name": "applicationVendor", "type": "string", "info": "", "required": false, "schema": { "title": "applicationVendor", "type": "string" } }, { "name": "applicationVersion", "type": "string", "info": "", "required": false, "schema": { "title": "applicationVersion", "type": "string" } }, { "name": "prevSnapshotId", "type": "string", "info": "", "required": false, "schema": { "title": "prevSnapshotId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionSnapshots" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship", "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesIm...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum", "summary": "returns metadatum", "description": "returns metadatum", "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum", "summary": "create or update an existing metadatum", "description": "Create or update an existing metadatum.\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": "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesImage...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum", "summary": "update an existing metadatum", "description": "Update an existing metadatum\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": "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum 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": "/updateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum", "summary": "delete an existing metadatum", "description": "delete an existing metadatum", "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata", "summary": "returns metadata", "description": "returns metadata", "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": false, "schema": { "title": "metaname", "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": "/getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionImagesImage", "summary": "returns image", "description": "returns image", "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionImagesImage" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage", "summary": "create or update an existing image", "description": "Create or update an existing image.\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": "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "body", "type": "object", "info": "image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesImage.jso...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionImagesImage", "summary": "update an existing image", "description": "Update an existing image\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 valu...(description truncated)", "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "type": "string" } }, { "name": "body", "type": "object", "info": "image 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": "/updateCloudInfrastructureCloudRegionsCloudRegionImagesImage" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage", "summary": "delete an existing image", "description": "delete an existing image", "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": "imageId", "type": "string", "info": "Image id, expected to be unique across cloud region", "required": true, "schema": { "title": "imageId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionImages", "summary": "returns images", "description": "returns images", "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": "imageId", "type": "string", "info": "", "required": false, "schema": { "title": "imageId", "type": "string" } }, { "name": "imageName", "type": "string", "info": "", "required": false, "schema": { "title": "imageName", "type": "string" } }, { "name": "application", "type": "string", "info": "", "required": false, "schema": { "title": "application", "type": "string" } }, { "name": "applicationVendor", "type": "string", "info": "", "required": false, "schema": { "title": "applicationVendor", "type": "string" } }, { "name": "applicationVersion", "type": "string", "info": "", "required": false, "schema": { "title": "applicationVersion", "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": "/getCloudInfrastructureCloudRegionsCloudRegionImages" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship", "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": "switchName", "type": "string", "info": "DVS switch name", "required": true, "schema": { "title": "switchName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionDvsSwitc...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "switchName", "type": "string", "info": "DVS switch name", "required": true, "schema": { "title": "switchName", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch", "summary": "returns dvs-switch", "description": "returns dvs-switch", "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": "switchName", "type": "string", "info": "DVS switch name", "required": true, "schema": { "title": "switchName", "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": "/getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch", "summary": "create or update an existing dvs-switch", "description": "Create or update an existing dvs-switch.\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": "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": "switchName", "type": "string", "info": "DVS switch name", "required": true, "schema": { "title": "switchName", "type": "string" } }, { "name": "body", "type": "object", "info": "dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionDvsSwitche...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch", "summary": "update an existing dvs-switch", "description": "Update an existing dvs-switch\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": "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": "switchName", "type": "string", "info": "DVS switch name", "required": true, "schema": { "title": "switchName", "type": "string" } }, { "name": "body", "type": "object", "info": "dvs-switch 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": "/updateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch", "summary": "delete an existing dvs-switch", "description": "delete an existing dvs-switch", "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": "switchName", "type": "string", "info": "DVS switch name", "required": true, "schema": { "title": "switchName", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches", "summary": "returns dvs-switches", "description": "returns dvs-switches", "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": "switchName", "type": "string", "info": "", "required": false, "schema": { "title": "switchName", "type": "string" } }, { "name": "vcenterUrl", "type": "string", "info": "", "required": false, "schema": { "title": "vcenterUrl", "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": "/getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship", "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": "networkUuid", "type": "string", "info": "UUID of the network. Unique across a cloud-region", "required": true, "schema": { "title": "networkUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionOamNetwo...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "networkUuid", "type": "string", "info": "UUID of the network. Unique across a cloud-region", "required": true, "schema": { "title": "networkUuid", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork", "summary": "returns oam-network", "description": "returns oam-network", "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": "networkUuid", "type": "string", "info": "UUID of the network. Unique across a cloud-region", "required": true, "schema": { "title": "networkUuid", "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": "/getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork", "summary": "create or update an existing oam-network", "description": "Create or update an existing oam-network.\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": "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": "networkUuid", "type": "string", "info": "UUID of the network. Unique across a cloud-region", "required": true, "schema": { "title": "networkUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionOamNetwor...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork", "summary": "update an existing oam-network", "description": "Update an existing oam-network\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 require...(description truncated)", "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": "networkUuid", "type": "string", "info": "UUID of the network. Unique across a cloud-region", "required": true, "schema": { "title": "networkUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "oam-network 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": "/updateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork", "summary": "delete an existing oam-network", "description": "delete an existing oam-network", "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": "networkUuid", "type": "string", "info": "UUID of the network. Unique across a cloud-region", "required": true, "schema": { "title": "networkUuid", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionOamNetworks", "summary": "returns oam-networks", "description": "returns oam-networks", "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": "networkUuid", "type": "string", "info": "", "required": false, "schema": { "title": "networkUuid", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "type": "string" } }, { "name": "cvlanTag", "type": "number", "info": "", "required": false, "schema": { "title": "cvlanTag", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCloudInfrastructureCloudRegionsCloudRegionOamNetworks" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship", "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": "availabilityZoneName", "type": "string", "info": "Name of the availability zone. Unique across a cloud region", "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/CloudInfrastructureCloudRegionsCloudRegionAvailabi...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "availabilityZoneName", "type": "string", "info": "Name of the availability zone. Unique across a cloud region", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone", "summary": "returns availability-zone", "description": "returns availability-zone", "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": "availabilityZoneName", "type": "string", "info": "Name of the availability zone. Unique across a cloud region", "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": "/getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone", "summary": "create or update an existing availability-zone", "description": "Create or update an existing availability-zone.\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": "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": "availabilityZoneName", "type": "string", "info": "Name of the availability zone. Unique across a cloud region", "required": true, "schema": { "title": "availabilityZoneName", "type": "string" } }, { "name": "body", "type": "object", "info": "availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionAva...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone", "summary": "update an existing availability-zone", "description": "Update an existing availability-zone\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 r...(description truncated)", "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": "availabilityZoneName", "type": "string", "info": "Name of the availability zone. Unique across a cloud region", "required": true, "schema": { "title": "availabilityZoneName", "type": "string" } }, { "name": "body", "type": "object", "info": "availability-zone 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": "/updateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone", "summary": "delete an existing availability-zone", "description": "delete an existing availability-zone", "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": "availabilityZoneName", "type": "string", "info": "Name of the availability zone. Unique across a cloud region", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones", "summary": "returns availability-zones", "description": "returns availability-zones", "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": "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": "/getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship", "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": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegion.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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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" } } ], "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship", "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": "vipIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv4A...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "vipIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv4Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList", "summary": "returns vip-ipv4-address-list", "description": "returns vip-ipv4-address-list", "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": "vipIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv4Address", "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": "/getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList", "summary": "create or update an existing vip-ipv4-address-list", "description": "Create or update an existing vip-ipv4-address-list.\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": "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": "vipIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegio...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList", "summary": "update an existing vip-ipv4-address-list", "description": "Update an existing vip-ipv4-address-list\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 ...(description truncated)", "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": "vipIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "vip-ipv4-address-list 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": "/updateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList", "summary": "delete an existing vip-ipv4-address-list", "description": "delete an existing vip-ipv4-address-list", "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": "vipIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv4Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship", "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": "vipIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv6A...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "vipIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv6Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList", "summary": "returns vip-ipv6-address-list", "description": "returns vip-ipv6-address-list", "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": "vipIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv6Address", "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": "/getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList", "summary": "create or update an existing vip-ipv6-address-list", "description": "Create or update an existing vip-ipv6-address-list.\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": "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": "vipIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegio...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList", "summary": "update an existing vip-ipv6-address-list", "description": "Update an existing vip-ipv6-address-list\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 ...(description truncated)", "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": "vipIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "vip-ipv6-address-list 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": "/updateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList", "summary": "delete an existing vip-ipv6-address-list", "description": "delete an existing vip-ipv6-address-list", "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": "vipIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "vipIpv6Address", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapab...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapab...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes", "summary": "returns hpa-feature-attributes", "description": "returns hpa-feature-attributes", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "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": "/getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes", "summary": "create or update an existing hpa-feature-attributes", "description": "Create or update an existing hpa-feature-attributes.\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": "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegi...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes", "summary": "update an existing hpa-feature-attributes", "description": "Update an existing hpa-feature-attributes\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...(description truncated)", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-feature-attributes 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": "/updateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes", "summary": "delete an existing hpa-feature-attributes", "description": "delete an existing hpa-feature-attributes", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaAttributeKey", "type": "string", "info": "name of the specific HPA attribute", "required": true, "schema": { "title": "hpaAttributeKey", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability", "summary": "returns hpa-capability", "description": "returns hpa-capability", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability", "summary": "create or update an existing hpa-capability", "description": "Create or update an existing hpa-capability.\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": "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCap...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability", "summary": "update an existing hpa-capability", "description": "Update an existing hpa-capability\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 requ...(description truncated)", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-capability 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": "/updateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability", "summary": "delete an existing hpa-capability", "description": "delete an existing hpa-capability", "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": "hpaCapabilityId", "type": "string", "info": "UUID to uniquely identify a HPA capability", "required": true, "schema": { "title": "hpaCapabilityId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities", "summary": "returns hpa-capabilities", "description": "returns hpa-capabilities", "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": "hpaCapabilityId", "type": "string", "info": "", "required": false, "schema": { "title": "hpaCapabilityId", "type": "string" } }, { "name": "hpaFeature", "type": "string", "info": "", "required": false, "schema": { "title": "hpaFeature", "type": "string" } }, { "name": "architecture", "type": "string", "info": "", "required": false, "schema": { "title": "architecture", "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": "/getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "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": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionEsrSyste...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "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": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo", "summary": "returns esr-system-info", "description": "returns esr-system-info", "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": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo", "summary": "create or update an existing esr-system-info", "description": "Create or update an existing esr-system-info.\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": "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": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionEsrSy...(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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo", "summary": "update an existing esr-system-info", "description": "Update an existing esr-system-info\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 req...(description truncated)", "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": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info 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": "/updateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo", "summary": "delete an existing esr-system-info", "description": "delete an existing esr-system-info", "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": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList", "summary": "returns esr-system-info-list", "description": "returns esr-system-info-list", "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": "esrSystemInfoId", "type": "string", "info": "", "required": false, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "systemName", "type": "string", "info": "", "required": false, "schema": { "title": "systemName", "type": "string" } }, { "name": "systemType", "type": "string", "info": "", "required": false, "schema": { "title": "systemType", "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": "/getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList" }, "task": true }, { "name": "getCloudInfrastructureCloudRegionsCloudRegion", "summary": "returns cloud-region", "description": "returns cloud-region", "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" } } ], "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": "/getCloudInfrastructureCloudRegionsCloudRegion" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureCloudRegionsCloudRegion", "summary": "create or update an existing cloud-region", "description": "Create or update an existing cloud-region.\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": "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": "body", "type": "object", "info": "cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegion.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": "/createOrUpdateCloudInfrastructureCloudRegionsCloudRegion" }, "task": true }, { "name": "updateCloudInfrastructureCloudRegionsCloudRegion", "summary": "update an existing cloud-region", "description": "Update an existing cloud-region\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 requir...(description truncated)", "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": "body", "type": "object", "info": "cloud-region 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": "/updateCloudInfrastructureCloudRegionsCloudRegion" }, "task": true }, { "name": "deleteCloudInfrastructureCloudRegionsCloudRegion", "summary": "delete an existing cloud-region", "description": "delete an existing cloud-region", "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": "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": "/deleteCloudInfrastructureCloudRegionsCloudRegion" }, "task": true }, { "name": "getCloudInfrastructureCloudRegions", "summary": "returns cloud-regions", "description": "returns cloud-regions", "input": [ { "name": "cloudOwner", "type": "string", "info": "", "required": false, "schema": { "title": "cloudOwner", "type": "string" } }, { "name": "cloudRegionId", "type": "string", "info": "", "required": false, "schema": { "title": "cloudRegionId", "type": "string" } }, { "name": "cloudType", "type": "string", "info": "", "required": false, "schema": { "title": "cloudType", "type": "string" } }, { "name": "ownerDefinedType", "type": "string", "info": "", "required": false, "schema": { "title": "ownerDefinedType", "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": "/getCloudInfrastructureCloudRegions" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "nmProfileName", "type": "string", "info": "Unique name of network profile.", "required": true, "schema": { "title": "nmProfileName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkProfilesNetworkProfile.j...(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": "/createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "nmProfileName", "type": "string", "info": "Unique name of network profile.", "required": true, "schema": { "title": "nmProfileName", "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": "/deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureNetworkProfilesNetworkProfile", "summary": "returns network-profile", "description": "returns network-profile", "input": [ { "name": "nmProfileName", "type": "string", "info": "Unique name of network profile.", "required": true, "schema": { "title": "nmProfileName", "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": "/getCloudInfrastructureNetworkProfilesNetworkProfile" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile", "summary": "create or update an existing network-profile", "description": "Create or update an existing network-profile.\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": "nmProfileName", "type": "string", "info": "Unique name of network profile.", "required": true, "schema": { "title": "nmProfileName", "type": "string" } }, { "name": "body", "type": "object", "info": "network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkProfilesNetworkProfil...(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": "/createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile" }, "task": true }, { "name": "updateCloudInfrastructureNetworkProfilesNetworkProfile", "summary": "update an existing network-profile", "description": "Update an existing network-profile\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 req...(description truncated)", "input": [ { "name": "nmProfileName", "type": "string", "info": "Unique name of network profile.", "required": true, "schema": { "title": "nmProfileName", "type": "string" } }, { "name": "body", "type": "object", "info": "network-profile 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": "/updateCloudInfrastructureNetworkProfilesNetworkProfile" }, "task": true }, { "name": "deleteCloudInfrastructureNetworkProfilesNetworkProfile", "summary": "delete an existing network-profile", "description": "delete an existing network-profile", "input": [ { "name": "nmProfileName", "type": "string", "info": "Unique name of network profile.", "required": true, "schema": { "title": "nmProfileName", "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": "/deleteCloudInfrastructureNetworkProfilesNetworkProfile" }, "task": true }, { "name": "getCloudInfrastructureNetworkProfiles", "summary": "returns network-profiles", "description": "returns network-profiles", "input": [ { "name": "nmProfileName", "type": "string", "info": "", "required": false, "schema": { "title": "nmProfileName", "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": "/getCloudInfrastructureNetworkProfiles" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserver.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": "/createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "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": "/deleteCloudInfrastructurePserversPserverRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf", "summary": "returns sriov-pf", "description": "returns sriov-pf", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf", "summary": "create or update an existing sriov-pf", "description": "Create or update an existing sriov-pf.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfac...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf", "summary": "update an existing sriov-pf", "description": "Update an existing sriov-pf\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 v...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-pf 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf", "summary": "delete an existing sriov-pf", "description": "delete an existing sriov-pf", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs", "summary": "returns sriov-pfs", "description": "returns sriov-pfs", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "", "required": false, "schema": { "title": "pfPciId", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserv...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserv...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLIn...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfac...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserv...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserv...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInter...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNameQuery", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceNameQuery", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfacesPInterface", "summary": "returns p-interface", "description": "returns p-interface", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/getCloudInfrastructurePserversPserverPInterfacesPInterface" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface", "summary": "create or update an existing p-interface", "description": "Create or update an existing p-interface.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInter...(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": "/createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverPInterfacesPInterface", "summary": "update an existing p-interface", "description": "Update an existing p-interface\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 require...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "p-interface 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": "/updateCloudInfrastructurePserversPserverPInterfacesPInterface" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverPInterfacesPInterface", "summary": "delete an existing p-interface", "description": "delete an existing p-interface", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteCloudInfrastructurePserversPserverPInterfacesPInterface" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverPInterfaces", "summary": "returns p-interfaces", "description": "returns p-interfaces", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "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": "/getCloudInfrastructurePserversPserverPInterfaces" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLag...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLag...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLag...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserv...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLag...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserv...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfac...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLag...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInte...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLag...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLag...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserv...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLag...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserv...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagI...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNameQuery", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceNameQuery", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfacesLagInterface", "summary": "returns lag-interface", "description": "returns lag-interface", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/getCloudInfrastructurePserversPserverLagInterfacesLagInterface" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface", "summary": "create or update an existing lag-interface", "description": "Create or update an existing lag-interface.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLa...(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": "/createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverLagInterfacesLagInterface", "summary": "update an existing lag-interface", "description": "Update an existing lag-interface\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 requi...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-interface 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": "/updateCloudInfrastructurePserversPserverLagInterfacesLagInterface" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface", "summary": "delete an existing lag-interface", "description": "delete an existing lag-interface", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverLagInterfaces", "summary": "returns lag-interfaces", "description": "returns lag-interfaces", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "interfaceRole", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceRole", "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": "/getCloudInfrastructurePserversPserverLagInterfaces" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverHpaCapacityRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "hpaCapacityKey", "type": "string", "info": "Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check", "required": true, "schema": { "title": "hpaCapacityKey", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverHpaCapacity.json...(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": "/createOrUpdateCloudInfrastructurePserversPserverHpaCapacityRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverHpaCapacityRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "hpaCapacityKey", "type": "string", "info": "Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check", "required": true, "schema": { "title": "hpaCapacityKey", "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": "/deleteCloudInfrastructurePserversPserverHpaCapacityRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructurePserversPserverHpaCapacity", "summary": "returns hpa-capacity", "description": "returns hpa-capacity", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "hpaCapacityKey", "type": "string", "info": "Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check", "required": true, "schema": { "title": "hpaCapacityKey", "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": "/getCloudInfrastructurePserversPserverHpaCapacity" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserverHpaCapacity", "summary": "create or update an existing hpa-capacity", "description": "Create or update an existing hpa-capacity.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "hpaCapacityKey", "type": "string", "info": "Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check", "required": true, "schema": { "title": "hpaCapacityKey", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-capacity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverHpaCapacity.json...(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": "/createOrUpdateCloudInfrastructurePserversPserverHpaCapacity" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserverHpaCapacity", "summary": "update an existing hpa-capacity", "description": "Update an existing hpa-capacity\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 requir...(description truncated)", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "hpaCapacityKey", "type": "string", "info": "Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check", "required": true, "schema": { "title": "hpaCapacityKey", "type": "string" } }, { "name": "body", "type": "object", "info": "hpa-capacity 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": "/updateCloudInfrastructurePserversPserverHpaCapacity" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserverHpaCapacity", "summary": "delete an existing hpa-capacity", "description": "delete an existing hpa-capacity", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "hpaCapacityKey", "type": "string", "info": "Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check", "required": true, "schema": { "title": "hpaCapacityKey", "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": "/deleteCloudInfrastructurePserversPserverHpaCapacity" }, "task": true }, { "name": "getCloudInfrastructurePserversPserver", "summary": "returns pserver", "description": "returns pserver", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "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": "/getCloudInfrastructurePserversPserver" }, "task": true }, { "name": "createOrUpdateCloudInfrastructurePserversPserver", "summary": "create or update an existing pserver", "description": "Create or update an existing pserver.\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "body", "type": "object", "info": "pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserver.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": "/createOrUpdateCloudInfrastructurePserversPserver" }, "task": true }, { "name": "updateCloudInfrastructurePserversPserver", "summary": "update an existing pserver", "description": "Update an existing pserver\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": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "type": "string" } }, { "name": "body", "type": "object", "info": "pserver 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": "/updateCloudInfrastructurePserversPserver" }, "task": true }, { "name": "deleteCloudInfrastructurePserversPserver", "summary": "delete an existing pserver", "description": "delete an existing pserver", "input": [ { "name": "hostname", "type": "string", "info": "Value from executing hostname on the compute node.", "required": true, "schema": { "title": "hostname", "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": "/deleteCloudInfrastructurePserversPserver" }, "task": true }, { "name": "getCloudInfrastructurePservers", "summary": "returns pservers", "description": "returns pservers", "input": [ { "name": "hostname", "type": "string", "info": "", "required": false, "schema": { "title": "hostname", "type": "string" } }, { "name": "invStatus", "type": "string", "info": "", "required": false, "schema": { "title": "invStatus", "type": "string" } }, { "name": "pserverId", "type": "string", "info": "", "required": false, "schema": { "title": "pserverId", "type": "string" } }, { "name": "inMaint", "type": "boolean", "info": "", "required": false, "schema": { "title": "inMaint", "type": "boolean" } }, { "name": "pserverName2", "type": "string", "info": "", "required": false, "schema": { "title": "pserverName2", "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": "/getCloudInfrastructurePservers" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vdcId", "type": "string", "info": "Unique ID of the vdc", "required": true, "schema": { "title": "vdcId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureVirtualDataCentersVirtualDataCe...(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": "/createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vdcId", "type": "string", "info": "Unique ID of the vdc", "required": true, "schema": { "title": "vdcId", "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": "/deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureVirtualDataCentersVirtualDataCenter", "summary": "returns virtual-data-center", "description": "returns virtual-data-center", "input": [ { "name": "vdcId", "type": "string", "info": "Unique ID of the vdc", "required": true, "schema": { "title": "vdcId", "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": "/getCloudInfrastructureVirtualDataCentersVirtualDataCenter" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter", "summary": "create or update an existing virtual-data-center", "description": "Create or update an existing virtual-data-center.\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": "vdcId", "type": "string", "info": "Unique ID of the vdc", "required": true, "schema": { "title": "vdcId", "type": "string" } }, { "name": "body", "type": "object", "info": "virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureVirtualDataCentersVirtua...(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": "/createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter" }, "task": true }, { "name": "updateCloudInfrastructureVirtualDataCentersVirtualDataCenter", "summary": "update an existing virtual-data-center", "description": "Update an existing virtual-data-center\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...(description truncated)", "input": [ { "name": "vdcId", "type": "string", "info": "Unique ID of the vdc", "required": true, "schema": { "title": "vdcId", "type": "string" } }, { "name": "body", "type": "object", "info": "virtual-data-center 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": "/updateCloudInfrastructureVirtualDataCentersVirtualDataCenter" }, "task": true }, { "name": "deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter", "summary": "delete an existing virtual-data-center", "description": "delete an existing virtual-data-center", "input": [ { "name": "vdcId", "type": "string", "info": "Unique ID of the vdc", "required": true, "schema": { "title": "vdcId", "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": "/deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter" }, "task": true }, { "name": "getCloudInfrastructureVirtualDataCenters", "summary": "returns virtual-data-centers", "description": "returns virtual-data-centers", "input": [ { "name": "vdcId", "type": "string", "info": "", "required": false, "schema": { "title": "vdcId", "type": "string" } }, { "name": "vdcName", "type": "string", "info": "", "required": false, "schema": { "title": "vdcName", "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": "/getCloudInfrastructureVirtualDataCenters" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "operationalEnvironmentId", "type": "string", "info": "UUID of an operational environment", "required": true, "schema": { "title": "operationalEnvironmentId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureOperationalEnvironmentsOperatio...(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": "/createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "operationalEnvironmentId", "type": "string", "info": "UUID of an operational environment", "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": "/deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment", "summary": "returns operational-environment", "description": "returns operational-environment", "input": [ { "name": "operationalEnvironmentId", "type": "string", "info": "UUID of an operational environment", "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": "/getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment", "summary": "create or update an existing operational-environment", "description": "Create or update an existing operational-environment.\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": "operationalEnvironmentId", "type": "string", "info": "UUID of an operational environment", "required": true, "schema": { "title": "operationalEnvironmentId", "type": "string" } }, { "name": "body", "type": "object", "info": "operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureOperationalEnvironme...(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": "/createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment" }, "task": true }, { "name": "updateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment", "summary": "update an existing operational-environment", "description": "Update an existing operational-environment\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 ar...(description truncated)", "input": [ { "name": "operationalEnvironmentId", "type": "string", "info": "UUID of an operational environment", "required": true, "schema": { "title": "operationalEnvironmentId", "type": "string" } }, { "name": "body", "type": "object", "info": "operational-environment 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": "/updateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment" }, "task": true }, { "name": "deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment", "summary": "delete an existing operational-environment", "description": "delete an existing operational-environment", "input": [ { "name": "operationalEnvironmentId", "type": "string", "info": "UUID of an operational environment", "required": true, "schema": { "title": "operationalEnvironmentId", "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": "/deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment" }, "task": true }, { "name": "getCloudInfrastructureOperationalEnvironments", "summary": "returns operational-environments", "description": "returns operational-environments", "input": [ { "name": "operationalEnvironmentId", "type": "string", "info": "", "required": false, "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": "/getCloudInfrastructureOperationalEnvironments" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureNetworkTechnologiesNetworkTechnologyRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkTechnologyId", "type": "string", "info": "Unique identifier of the network-technology object (UUID)", "required": true, "schema": { "title": "networkTechnologyId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkTechnologiesNetworkTechn...(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": "/createOrUpdateCloudInfrastructureNetworkTechnologiesNetworkTechnologyRelationshipListRelationship" }, "task": true }, { "name": "deleteCloudInfrastructureNetworkTechnologiesNetworkTechnologyRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkTechnologyId", "type": "string", "info": "Unique identifier of the network-technology object (UUID)", "required": true, "schema": { "title": "networkTechnologyId", "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": "/deleteCloudInfrastructureNetworkTechnologiesNetworkTechnologyRelationshipListRelationship" }, "task": true }, { "name": "getCloudInfrastructureNetworkTechnologiesNetworkTechnology", "summary": "returns network-technology", "description": "returns network-technology", "input": [ { "name": "networkTechnologyId", "type": "string", "info": "Unique identifier of the network-technology object (UUID)", "required": true, "schema": { "title": "networkTechnologyId", "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": "/getCloudInfrastructureNetworkTechnologiesNetworkTechnology" }, "task": true }, { "name": "createOrUpdateCloudInfrastructureNetworkTechnologiesNetworkTechnology", "summary": "create or update an existing network-technology", "description": "Create or update an existing network-technology.\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": "networkTechnologyId", "type": "string", "info": "Unique identifier of the network-technology object (UUID)", "required": true, "schema": { "title": "networkTechnologyId", "type": "string" } }, { "name": "body", "type": "object", "info": "network-technology object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkTechnologiesNetwor...(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": "/createOrUpdateCloudInfrastructureNetworkTechnologiesNetworkTechnology" }, "task": true }, { "name": "updateCloudInfrastructureNetworkTechnologiesNetworkTechnology", "summary": "update an existing network-technology", "description": "Update an existing network-technology\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 ...(description truncated)", "input": [ { "name": "networkTechnologyId", "type": "string", "info": "Unique identifier of the network-technology object (UUID)", "required": true, "schema": { "title": "networkTechnologyId", "type": "string" } }, { "name": "body", "type": "object", "info": "network-technology 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": "/updateCloudInfrastructureNetworkTechnologiesNetworkTechnology" }, "task": true }, { "name": "deleteCloudInfrastructureNetworkTechnologiesNetworkTechnology", "summary": "delete an existing network-technology", "description": "delete an existing network-technology", "input": [ { "name": "networkTechnologyId", "type": "string", "info": "Unique identifier of the network-technology object (UUID)", "required": true, "schema": { "title": "networkTechnologyId", "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": "/deleteCloudInfrastructureNetworkTechnologiesNetworkTechnology" }, "task": true }, { "name": "getCloudInfrastructureNetworkTechnologies", "summary": "returns network-technologies", "description": "returns network-technologies", "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": "/getCloudInfrastructureNetworkTechnologies" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsr...(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": "/createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "getExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo", "summary": "returns esr-system-info", "description": "returns esr-system-info", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/getExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo", "summary": "create or update an existing esr-system-info", "description": "Create or update an existing esr-system-info.\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": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEmsEsrSystemInfoList...(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": "/createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "updateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo", "summary": "update an existing esr-system-info", "description": "Update an existing esr-system-info\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 req...(description truncated)", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info 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": "/updateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo", "summary": "delete an existing esr-system-info", "description": "delete an existing esr-system-info", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "getExternalSystemEsrEmsListEsrEmsEsrSystemInfoList", "summary": "returns esr-system-info-list", "description": "returns esr-system-info-list", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "", "required": false, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "systemName", "type": "string", "info": "", "required": false, "schema": { "title": "systemName", "type": "string" } }, { "name": "systemType", "type": "string", "info": "", "required": false, "schema": { "title": "systemType", "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": "/getExternalSystemEsrEmsListEsrEmsEsrSystemInfoList" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrEmsListEsrEmsRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEms.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": "/createOrUpdateExternalSystemEsrEmsListEsrEmsRelationshipListRelationship" }, "task": true }, { "name": "deleteExternalSystemEsrEmsListEsrEmsRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "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": "/deleteExternalSystemEsrEmsListEsrEmsRelationshipListRelationship" }, "task": true }, { "name": "getExternalSystemEsrEmsListEsrEms", "summary": "returns esr-ems", "description": "returns esr-ems", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "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": "/getExternalSystemEsrEmsListEsrEms" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrEmsListEsrEms", "summary": "create or update an existing esr-ems", "description": "Create or update an existing esr-ems.\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": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-ems object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEms.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": "/createOrUpdateExternalSystemEsrEmsListEsrEms" }, "task": true }, { "name": "updateExternalSystemEsrEmsListEsrEms", "summary": "update an existing esr-ems", "description": "Update an existing esr-ems\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": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-ems 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": "/updateExternalSystemEsrEmsListEsrEms" }, "task": true }, { "name": "deleteExternalSystemEsrEmsListEsrEms", "summary": "delete an existing esr-ems", "description": "delete an existing esr-ems", "input": [ { "name": "emsId", "type": "string", "info": "Unique ID of EMS.", "required": true, "schema": { "title": "emsId", "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": "/deleteExternalSystemEsrEmsListEsrEms" }, "task": true }, { "name": "getExternalSystemEsrEmsList", "summary": "returns esr-ems-list", "description": "returns esr-ems-list", "input": [ { "name": "emsId", "type": "string", "info": "", "required": false, "schema": { "title": "emsId", "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": "/getExternalSystemEsrEmsList" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListE...(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": "/createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo", "summary": "returns esr-system-info", "description": "returns esr-system-info", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo", "summary": "create or update an existing esr-system-info", "description": "Create or update an existing esr-system-info.\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": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoLi...(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": "/createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "updateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo", "summary": "update an existing esr-system-info", "description": "Update an existing esr-system-info\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 req...(description truncated)", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info 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": "/updateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo", "summary": "delete an existing esr-system-info", "description": "delete an existing esr-system-info", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoList", "summary": "returns esr-system-info-list", "description": "returns esr-system-info-list", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "", "required": false, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "systemName", "type": "string", "info": "", "required": false, "schema": { "title": "systemName", "type": "string" } }, { "name": "systemType", "type": "string", "info": "", "required": false, "schema": { "title": "systemType", "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": "/getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoList" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfm.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": "/createOrUpdateExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship" }, "task": true }, { "name": "deleteExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "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": "/deleteExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship" }, "task": true }, { "name": "getExternalSystemEsrVnfmListEsrVnfm", "summary": "returns esr-vnfm", "description": "returns esr-vnfm", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "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": "/getExternalSystemEsrVnfmListEsrVnfm" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrVnfmListEsrVnfm", "summary": "create or update an existing esr-vnfm", "description": "Create or update an existing esr-vnfm.\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": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-vnfm object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfm.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": "/createOrUpdateExternalSystemEsrVnfmListEsrVnfm" }, "task": true }, { "name": "updateExternalSystemEsrVnfmListEsrVnfm", "summary": "update an existing esr-vnfm", "description": "Update an existing esr-vnfm\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 v...(description truncated)", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-vnfm 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": "/updateExternalSystemEsrVnfmListEsrVnfm" }, "task": true }, { "name": "deleteExternalSystemEsrVnfmListEsrVnfm", "summary": "delete an existing esr-vnfm", "description": "delete an existing esr-vnfm", "input": [ { "name": "vnfmId", "type": "string", "info": "Unique ID of VNFM.", "required": true, "schema": { "title": "vnfmId", "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": "/deleteExternalSystemEsrVnfmListEsrVnfm" }, "task": true }, { "name": "getExternalSystemEsrVnfmList", "summary": "returns esr-vnfm-list", "description": "returns esr-vnfm-list", "input": [ { "name": "vnfmId", "type": "string", "info": "", "required": false, "schema": { "title": "vnfmId", "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": "/getExternalSystemEsrVnfmList" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListE...(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": "/createOrUpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "deleteExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "getExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo", "summary": "returns esr-system-info", "description": "returns esr-system-info", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/getExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo", "summary": "create or update an existing esr-system-info", "description": "Create or update an existing esr-system-info.\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": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoLi...(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": "/createOrUpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "updateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo", "summary": "update an existing esr-system-info", "description": "Update an existing esr-system-info\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 req...(description truncated)", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info 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": "/updateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "deleteExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo", "summary": "delete an existing esr-system-info", "description": "delete an existing esr-system-info", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "getExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoList", "summary": "returns esr-system-info-list", "description": "returns esr-system-info-list", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "", "required": false, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "systemName", "type": "string", "info": "", "required": false, "schema": { "title": "systemName", "type": "string" } }, { "name": "systemType", "type": "string", "info": "", "required": false, "schema": { "title": "systemType", "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": "/getExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoList" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrNfvoListEsrNfvoRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvo.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": "/createOrUpdateExternalSystemEsrNfvoListEsrNfvoRelationshipListRelationship" }, "task": true }, { "name": "deleteExternalSystemEsrNfvoListEsrNfvoRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "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": "/deleteExternalSystemEsrNfvoListEsrNfvoRelationshipListRelationship" }, "task": true }, { "name": "getExternalSystemEsrNfvoListEsrNfvo", "summary": "returns esr-nfvo", "description": "returns esr-nfvo", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "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": "/getExternalSystemEsrNfvoListEsrNfvo" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrNfvoListEsrNfvo", "summary": "create or update an existing esr-nfvo", "description": "Create or update an existing esr-nfvo.\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": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-nfvo object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvo.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": "/createOrUpdateExternalSystemEsrNfvoListEsrNfvo" }, "task": true }, { "name": "updateExternalSystemEsrNfvoListEsrNfvo", "summary": "update an existing esr-nfvo", "description": "Update an existing esr-nfvo\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 v...(description truncated)", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-nfvo 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": "/updateExternalSystemEsrNfvoListEsrNfvo" }, "task": true }, { "name": "deleteExternalSystemEsrNfvoListEsrNfvo", "summary": "delete an existing esr-nfvo", "description": "delete an existing esr-nfvo", "input": [ { "name": "nfvoId", "type": "string", "info": "Unique ID of nfvo.", "required": true, "schema": { "title": "nfvoId", "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": "/deleteExternalSystemEsrNfvoListEsrNfvo" }, "task": true }, { "name": "getExternalSystemEsrNfvoList", "summary": "returns esr-nfvo-list", "description": "returns esr-nfvo-list", "input": [ { "name": "nfvoId", "type": "string", "info": "", "required": false, "schema": { "title": "nfvoId", "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": "/getExternalSystemEsrNfvoList" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySd...(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": "/createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo", "summary": "returns esr-system-info", "description": "returns esr-system-info", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo", "summary": "create or update an existing esr-system-info", "description": "Create or update an existing esr-system-info.\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": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpart...(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": "/createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "updateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo", "summary": "update an existing esr-system-info", "description": "Update an existing esr-system-info\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 req...(description truncated)", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info 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": "/updateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo", "summary": "delete an existing esr-system-info", "description": "delete an existing esr-system-info", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo" }, "task": true }, { "name": "getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoList", "summary": "returns esr-system-info-list", "description": "returns esr-system-info-list", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "", "required": false, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "systemName", "type": "string", "info": "", "required": false, "schema": { "title": "systemName", "type": "string" } }, { "name": "systemType", "type": "string", "info": "", "required": false, "schema": { "title": "systemType", "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": "/getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoList" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySd...(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": "/createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship" }, "task": true }, { "name": "deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "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": "/deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship" }, "task": true }, { "name": "getExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc", "summary": "returns esr-thirdparty-sdnc", "description": "returns esr-thirdparty-sdnc", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "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": "/getExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc" }, "task": true }, { "name": "createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc", "summary": "create or update an existing esr-thirdparty-sdnc", "description": "Create or update an existing esr-thirdparty-sdnc.\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": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-thirdparty-sdnc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThird...(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": "/createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc" }, "task": true }, { "name": "updateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc", "summary": "update an existing esr-thirdparty-sdnc", "description": "Update an existing esr-thirdparty-sdnc\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...(description truncated)", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-thirdparty-sdnc 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": "/updateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc" }, "task": true }, { "name": "deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc", "summary": "delete an existing esr-thirdparty-sdnc", "description": "delete an existing esr-thirdparty-sdnc", "input": [ { "name": "thirdpartySdncId", "type": "string", "info": "Unique ID of SDNC.", "required": true, "schema": { "title": "thirdpartySdncId", "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": "/deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc" }, "task": true }, { "name": "getExternalSystemEsrThirdpartySdncList", "summary": "returns esr-thirdparty-sdnc-list", "description": "returns esr-thirdparty-sdnc-list", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getExternalSystemEsrThirdpartySdncList" }, "task": true }, { "name": "createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnector.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": "/createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessConnectorsConnectorRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "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": "/deleteBusinessConnectorsConnectorRelationshipListRelationship" }, "task": true }, { "name": "getBusinessConnectorsConnectorMetadataMetadatum", "summary": "returns metadatum", "description": "returns metadatum", "input": [ { "name": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/getBusinessConnectorsConnectorMetadataMetadatum" }, "task": true }, { "name": "createOrUpdateBusinessConnectorsConnectorMetadataMetadatum", "summary": "create or update an existing metadatum", "description": "Create or update an existing metadatum.\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": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnectorMetadataMetadatum.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": "/createOrUpdateBusinessConnectorsConnectorMetadataMetadatum" }, "task": true }, { "name": "updateBusinessConnectorsConnectorMetadataMetadatum", "summary": "update an existing metadatum", "description": "Update an existing metadatum\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": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum 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": "/updateBusinessConnectorsConnectorMetadataMetadatum" }, "task": true }, { "name": "deleteBusinessConnectorsConnectorMetadataMetadatum", "summary": "delete an existing metadatum", "description": "delete an existing metadatum", "input": [ { "name": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/deleteBusinessConnectorsConnectorMetadataMetadatum" }, "task": true }, { "name": "getBusinessConnectorsConnectorMetadata", "summary": "returns metadata", "description": "returns metadata", "input": [ { "name": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": false, "schema": { "title": "metaname", "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": "/getBusinessConnectorsConnectorMetadata" }, "task": true }, { "name": "getBusinessConnectorsConnector", "summary": "returns connector", "description": "returns connector", "input": [ { "name": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "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": "/getBusinessConnectorsConnector" }, "task": true }, { "name": "createOrUpdateBusinessConnectorsConnector", "summary": "create or update an existing connector", "description": "Create or update an existing connector.\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": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnector.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": "/createOrUpdateBusinessConnectorsConnector" }, "task": true }, { "name": "updateBusinessConnectorsConnector", "summary": "update an existing connector", "description": "Update an existing connector\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": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "connector 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": "/updateBusinessConnectorsConnector" }, "task": true }, { "name": "deleteBusinessConnectorsConnector", "summary": "delete an existing connector", "description": "delete an existing connector", "input": [ { "name": "resourceInstanceId", "type": "string", "info": "Unique id of resource instance.", "required": true, "schema": { "title": "resourceInstanceId", "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": "/deleteBusinessConnectorsConnector" }, "task": true }, { "name": "getBusinessConnectors", "summary": "returns connectors", "description": "returns connectors", "input": [ { "name": "resourceInstanceId", "type": "string", "info": "", "required": false, "schema": { "title": "resourceInstanceId", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "widgetModelId", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelId", "type": "string" } }, { "name": "widgetModelVersion", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelVersion", "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": "/getBusinessConnectors" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServi...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "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": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum", "summary": "returns metadatum", "description": "returns metadatum", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum", "summary": "create or update an existing metadatum", "description": "Create or update an existing metadatum.\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": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceS...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum" }, "task": true }, { "name": "updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum", "summary": "update an existing metadatum", "description": "Update an existing metadatum\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": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum 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": "/updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum", "summary": "delete an existing metadatum", "description": "delete an existing metadatum", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata", "summary": "returns metadata", "description": "returns metadata", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": false, "schema": { "title": "metaname", "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": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "idPath", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "idPath", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServi...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "idPath", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "idPath", "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": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect", "summary": "returns tunnel-xconnect", "description": "returns tunnel-xconnect", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "idPath", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "idPath", "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": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect", "summary": "create or update an existing tunnel-xconnect", "description": "Create or update an existing tunnel-xconnect.\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": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "idPath", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "idPath", "type": "string" } }, { "name": "body", "type": "object", "info": "tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsSe...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect" }, "task": true }, { "name": "updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect", "summary": "update an existing tunnel-xconnect", "description": "Update an existing tunnel-xconnect\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 req...(description truncated)", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "idPath", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "idPath", "type": "string" } }, { "name": "body", "type": "object", "info": "tunnel-xconnect 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": "/updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect", "summary": "delete an existing tunnel-xconnect", "description": "delete an existing tunnel-xconnect", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "idPath", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "idPath", "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": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects", "summary": "returns tunnel-xconnects", "description": "returns tunnel-xconnects", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "idQuery", "type": "string", "info": "", "required": false, "schema": { "title": "idQuery", "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": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServi...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource", "summary": "returns allotted-resource", "description": "returns allotted-resource", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource", "summary": "create or update an existing allotted-resource", "description": "Create or update an existing allotted-resource.\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": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptions...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource" }, "task": true }, { "name": "updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource", "summary": "update an existing allotted-resource", "description": "Update an existing allotted-resource\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 r...(description truncated)", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "allotted-resource 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": "/updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource", "summary": "delete an existing allotted-resource", "description": "delete an existing allotted-resource", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "Allotted Resource id UUID assigned to this instance.", "required": true, "schema": { "title": "id", "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": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources", "summary": "returns allotted-resources", "description": "returns allotted-resources", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "id", "type": "string", "info": "", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "type", "type": "string", "info": "", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "role", "type": "string", "info": "", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "allottedResourceName", "type": "string", "info": "", "required": false, "schema": { "title": "allottedResourceName", "type": "string" } }, { "name": "accessProviderId", "type": "string", "info": "", "required": false, "schema": { "title": "accessProviderId", "type": "string" } }, { "name": "accessClientId", "type": "string", "info": "", "required": false, "schema": { "title": "accessClientId", "type": "string" } }, { "name": "accessTopologyId", "type": "string", "info": "", "required": false, "schema": { "title": "accessTopologyId", "type": "string" } }, { "name": "accessNodeId", "type": "string", "info": "", "required": false, "schema": { "title": "accessNodeId", "type": "string" } }, { "name": "accessLtpId", "type": "string", "info": "", "required": false, "schema": { "title": "accessLtpId", "type": "string" } }, { "name": "vpnName", "type": "string", "info": "", "required": false, "schema": { "title": "vpnName", "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": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance", "summary": "returns service-instance", "description": "returns service-instance", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "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": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance", "summary": "create or update an existing service-instance", "description": "Create or update an existing service-instance.\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": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsS...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance" }, "task": true }, { "name": "updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance", "summary": "update an existing service-instance", "description": "Update an existing service-instance\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 re...(description truncated)", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "service-instance 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": "/updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance", "summary": "delete an existing service-instance", "description": "delete an existing service-instance", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "Uniquely identifies this instance of a service", "required": true, "schema": { "title": "serviceInstanceId", "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": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances", "summary": "returns service-instances", "description": "returns service-instances", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "serviceInstanceId", "type": "string", "info": "", "required": false, "schema": { "title": "serviceInstanceId", "type": "string" } }, { "name": "serviceInstanceName", "type": "string", "info": "", "required": false, "schema": { "title": "serviceInstanceName", "type": "string" } }, { "name": "environmentContext", "type": "string", "info": "", "required": false, "schema": { "title": "environmentContext", "type": "string" } }, { "name": "workloadContext", "type": "string", "info": "", "required": false, "schema": { "title": "workloadContext", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "widgetModelId", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelId", "type": "string" } }, { "name": "widgetModelVersion", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelVersion", "type": "string" } }, { "name": "serviceInstanceLocationId", "type": "string", "info": "", "required": false, "schema": { "title": "serviceInstanceLocationId", "type": "string" } }, { "name": "orchestrationStatus", "type": "string", "info": "", "required": false, "schema": { "title": "orchestrationStatus", "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": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServi...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "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": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription", "summary": "returns service-subscription", "description": "returns service-subscription", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "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": "/getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription", "summary": "create or update an existing service-subscription", "description": "Create or update an existing service-subscription.\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": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "body", "type": "object", "info": "service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscripti...(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": "/createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription" }, "task": true }, { "name": "updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription", "summary": "update an existing service-subscription", "description": "Update an existing service-subscription\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 n...(description truncated)", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "body", "type": "object", "info": "service-subscription 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": "/updateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription" }, "task": true }, { "name": "deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription", "summary": "delete an existing service-subscription", "description": "delete an existing service-subscription", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Value defined by orchestration to identify this service across ONAP.", "required": true, "schema": { "title": "serviceType", "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": "/deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription" }, "task": true }, { "name": "getBusinessCustomersCustomerServiceSubscriptions", "summary": "returns service-subscriptions", "description": "returns service-subscriptions", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "", "required": false, "schema": { "title": "serviceType", "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": "/getBusinessCustomersCustomerServiceSubscriptions" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomerRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomer.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": "/createOrUpdateBusinessCustomersCustomerRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessCustomersCustomerRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "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": "/deleteBusinessCustomersCustomerRelationshipListRelationship" }, "task": true }, { "name": "getBusinessCustomersCustomer", "summary": "returns customer", "description": "returns customer", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "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": "/getBusinessCustomersCustomer" }, "task": true }, { "name": "createOrUpdateBusinessCustomersCustomer", "summary": "create or update an existing customer", "description": "Create or update an existing customer.\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": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "body", "type": "object", "info": "customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomer.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": "/createOrUpdateBusinessCustomersCustomer" }, "task": true }, { "name": "updateBusinessCustomersCustomer", "summary": "update an existing customer", "description": "Update an existing customer\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 v...(description truncated)", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "body", "type": "object", "info": "customer 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": "/updateBusinessCustomersCustomer" }, "task": true }, { "name": "deleteBusinessCustomersCustomer", "summary": "delete an existing customer", "description": "delete an existing customer", "input": [ { "name": "globalCustomerId", "type": "string", "info": "Global customer id used across ONAP to uniquely identify customer.", "required": true, "schema": { "title": "globalCustomerId", "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": "/deleteBusinessCustomersCustomer" }, "task": true }, { "name": "getBusinessCustomers", "summary": "returns customers", "description": "returns customers", "input": [ { "name": "globalCustomerId", "type": "string", "info": "", "required": false, "schema": { "title": "globalCustomerId", "type": "string" } }, { "name": "subscriberName", "type": "string", "info": "", "required": false, "schema": { "title": "subscriberName", "type": "string" } }, { "name": "subscriberType", "type": "string", "info": "", "required": false, "schema": { "title": "subscriberType", "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": "/getBusinessCustomers" }, "task": true }, { "name": "createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "lineOfBusinessName", "type": "string", "info": "Name of the line-of-business (product)", "required": true, "schema": { "title": "lineOfBusinessName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessLinesOfBusinessLineOfBusiness.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": "/createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "lineOfBusinessName", "type": "string", "info": "Name of the line-of-business (product)", "required": true, "schema": { "title": "lineOfBusinessName", "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": "/deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship" }, "task": true }, { "name": "getBusinessLinesOfBusinessLineOfBusiness", "summary": "returns line-of-business", "description": "returns line-of-business", "input": [ { "name": "lineOfBusinessName", "type": "string", "info": "Name of the line-of-business (product)", "required": true, "schema": { "title": "lineOfBusinessName", "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": "/getBusinessLinesOfBusinessLineOfBusiness" }, "task": true }, { "name": "createOrUpdateBusinessLinesOfBusinessLineOfBusiness", "summary": "create or update an existing line-of-business", "description": "Create or update an existing line-of-business.\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": "lineOfBusinessName", "type": "string", "info": "Name of the line-of-business (product)", "required": true, "schema": { "title": "lineOfBusinessName", "type": "string" } }, { "name": "body", "type": "object", "info": "line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessLinesOfBusinessLineOfBusiness.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": "/createOrUpdateBusinessLinesOfBusinessLineOfBusiness" }, "task": true }, { "name": "updateBusinessLinesOfBusinessLineOfBusiness", "summary": "update an existing line-of-business", "description": "Update an existing line-of-business\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 re...(description truncated)", "input": [ { "name": "lineOfBusinessName", "type": "string", "info": "Name of the line-of-business (product)", "required": true, "schema": { "title": "lineOfBusinessName", "type": "string" } }, { "name": "body", "type": "object", "info": "line-of-business 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": "/updateBusinessLinesOfBusinessLineOfBusiness" }, "task": true }, { "name": "deleteBusinessLinesOfBusinessLineOfBusiness", "summary": "delete an existing line-of-business", "description": "delete an existing line-of-business", "input": [ { "name": "lineOfBusinessName", "type": "string", "info": "Name of the line-of-business (product)", "required": true, "schema": { "title": "lineOfBusinessName", "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": "/deleteBusinessLinesOfBusinessLineOfBusiness" }, "task": true }, { "name": "getBusinessLinesOfBusiness", "summary": "returns lines-of-business", "description": "returns lines-of-business", "input": [ { "name": "lineOfBusinessName", "type": "string", "info": "", "required": false, "schema": { "title": "lineOfBusinessName", "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": "/getBusinessLinesOfBusiness" }, "task": true }, { "name": "createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "owningEntityId", "type": "string", "info": "UUID of an owning entity", "required": true, "schema": { "title": "owningEntityId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessOwningEntitiesOwningEntity.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": "/createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "owningEntityId", "type": "string", "info": "UUID of an owning entity", "required": true, "schema": { "title": "owningEntityId", "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": "/deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship" }, "task": true }, { "name": "getBusinessOwningEntitiesOwningEntity", "summary": "returns owning-entity", "description": "returns owning-entity", "input": [ { "name": "owningEntityId", "type": "string", "info": "UUID of an owning entity", "required": true, "schema": { "title": "owningEntityId", "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": "/getBusinessOwningEntitiesOwningEntity" }, "task": true }, { "name": "createOrUpdateBusinessOwningEntitiesOwningEntity", "summary": "create or update an existing owning-entity", "description": "Create or update an existing owning-entity.\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": "owningEntityId", "type": "string", "info": "UUID of an owning entity", "required": true, "schema": { "title": "owningEntityId", "type": "string" } }, { "name": "body", "type": "object", "info": "owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessOwningEntitiesOwningEntity.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": "/createOrUpdateBusinessOwningEntitiesOwningEntity" }, "task": true }, { "name": "updateBusinessOwningEntitiesOwningEntity", "summary": "update an existing owning-entity", "description": "Update an existing owning-entity\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 requi...(description truncated)", "input": [ { "name": "owningEntityId", "type": "string", "info": "UUID of an owning entity", "required": true, "schema": { "title": "owningEntityId", "type": "string" } }, { "name": "body", "type": "object", "info": "owning-entity 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": "/updateBusinessOwningEntitiesOwningEntity" }, "task": true }, { "name": "deleteBusinessOwningEntitiesOwningEntity", "summary": "delete an existing owning-entity", "description": "delete an existing owning-entity", "input": [ { "name": "owningEntityId", "type": "string", "info": "UUID of an owning entity", "required": true, "schema": { "title": "owningEntityId", "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": "/deleteBusinessOwningEntitiesOwningEntity" }, "task": true }, { "name": "getBusinessOwningEntities", "summary": "returns owning-entities", "description": "returns owning-entities", "input": [ { "name": "owningEntityId", "type": "string", "info": "", "required": false, "schema": { "title": "owningEntityId", "type": "string" } }, { "name": "owningEntityName", "type": "string", "info": "", "required": false, "schema": { "title": "owningEntityName", "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": "/getBusinessOwningEntities" }, "task": true }, { "name": "createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "platformName", "type": "string", "info": "Name of the platform", "required": true, "schema": { "title": "platformName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessPlatformsPlatform.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": "/createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessPlatformsPlatformRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "platformName", "type": "string", "info": "Name of the platform", "required": true, "schema": { "title": "platformName", "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": "/deleteBusinessPlatformsPlatformRelationshipListRelationship" }, "task": true }, { "name": "getBusinessPlatformsPlatform", "summary": "returns platform", "description": "returns platform", "input": [ { "name": "platformName", "type": "string", "info": "Name of the platform", "required": true, "schema": { "title": "platformName", "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": "/getBusinessPlatformsPlatform" }, "task": true }, { "name": "createOrUpdateBusinessPlatformsPlatform", "summary": "create or update an existing platform", "description": "Create or update an existing platform.\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": "platformName", "type": "string", "info": "Name of the platform", "required": true, "schema": { "title": "platformName", "type": "string" } }, { "name": "body", "type": "object", "info": "platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessPlatformsPlatform.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": "/createOrUpdateBusinessPlatformsPlatform" }, "task": true }, { "name": "updateBusinessPlatformsPlatform", "summary": "update an existing platform", "description": "Update an existing platform\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 v...(description truncated)", "input": [ { "name": "platformName", "type": "string", "info": "Name of the platform", "required": true, "schema": { "title": "platformName", "type": "string" } }, { "name": "body", "type": "object", "info": "platform 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": "/updateBusinessPlatformsPlatform" }, "task": true }, { "name": "deleteBusinessPlatformsPlatform", "summary": "delete an existing platform", "description": "delete an existing platform", "input": [ { "name": "platformName", "type": "string", "info": "Name of the platform", "required": true, "schema": { "title": "platformName", "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": "/deleteBusinessPlatformsPlatform" }, "task": true }, { "name": "getBusinessPlatforms", "summary": "returns platforms", "description": "returns platforms", "input": [ { "name": "platformName", "type": "string", "info": "", "required": false, "schema": { "title": "platformName", "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": "/getBusinessPlatforms" }, "task": true }, { "name": "createOrUpdateBusinessProjectsProjectRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "projectName", "type": "string", "info": "Name of the project deploying a service", "required": true, "schema": { "title": "projectName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessProjectsProject.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": "/createOrUpdateBusinessProjectsProjectRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessProjectsProjectRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "projectName", "type": "string", "info": "Name of the project deploying a service", "required": true, "schema": { "title": "projectName", "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": "/deleteBusinessProjectsProjectRelationshipListRelationship" }, "task": true }, { "name": "getBusinessProjectsProject", "summary": "returns project", "description": "returns project", "input": [ { "name": "projectName", "type": "string", "info": "Name of the project deploying a service", "required": true, "schema": { "title": "projectName", "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": "/getBusinessProjectsProject" }, "task": true }, { "name": "createOrUpdateBusinessProjectsProject", "summary": "create or update an existing project", "description": "Create or update an existing project.\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": "projectName", "type": "string", "info": "Name of the project deploying a service", "required": true, "schema": { "title": "projectName", "type": "string" } }, { "name": "body", "type": "object", "info": "project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessProjectsProject.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": "/createOrUpdateBusinessProjectsProject" }, "task": true }, { "name": "updateBusinessProjectsProject", "summary": "update an existing project", "description": "Update an existing project\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": "projectName", "type": "string", "info": "Name of the project deploying a service", "required": true, "schema": { "title": "projectName", "type": "string" } }, { "name": "body", "type": "object", "info": "project 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": "/updateBusinessProjectsProject" }, "task": true }, { "name": "deleteBusinessProjectsProject", "summary": "delete an existing project", "description": "delete an existing project", "input": [ { "name": "projectName", "type": "string", "info": "Name of the project deploying a service", "required": true, "schema": { "title": "projectName", "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": "/deleteBusinessProjectsProject" }, "task": true }, { "name": "getBusinessProjects", "summary": "returns projects", "description": "returns projects", "input": [ { "name": "projectName", "type": "string", "info": "", "required": false, "schema": { "title": "projectName", "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": "/getBusinessProjects" }, "task": true }, { "name": "createOrUpdateBusinessSpPartnersSpPartnerRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "spPartnerId", "type": "string", "info": "Uniquely identifies this sp-partner by id", "required": true, "schema": { "title": "spPartnerId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessSpPartnersSpPartner.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": "/createOrUpdateBusinessSpPartnersSpPartnerRelationshipListRelationship" }, "task": true }, { "name": "deleteBusinessSpPartnersSpPartnerRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "spPartnerId", "type": "string", "info": "Uniquely identifies this sp-partner by id", "required": true, "schema": { "title": "spPartnerId", "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": "/deleteBusinessSpPartnersSpPartnerRelationshipListRelationship" }, "task": true }, { "name": "getBusinessSpPartnersSpPartner", "summary": "returns sp-partner", "description": "returns sp-partner", "input": [ { "name": "spPartnerId", "type": "string", "info": "Uniquely identifies this sp-partner by id", "required": true, "schema": { "title": "spPartnerId", "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": "/getBusinessSpPartnersSpPartner" }, "task": true }, { "name": "createOrUpdateBusinessSpPartnersSpPartner", "summary": "create or update an existing sp-partner", "description": "Create or update an existing sp-partner.\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": "spPartnerId", "type": "string", "info": "Uniquely identifies this sp-partner by id", "required": true, "schema": { "title": "spPartnerId", "type": "string" } }, { "name": "body", "type": "object", "info": "sp-partner object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessSpPartnersSpPartner.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": "/createOrUpdateBusinessSpPartnersSpPartner" }, "task": true }, { "name": "updateBusinessSpPartnersSpPartner", "summary": "update an existing sp-partner", "description": "Update an existing sp-partner\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": "spPartnerId", "type": "string", "info": "Uniquely identifies this sp-partner by id", "required": true, "schema": { "title": "spPartnerId", "type": "string" } }, { "name": "body", "type": "object", "info": "sp-partner 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": "/updateBusinessSpPartnersSpPartner" }, "task": true }, { "name": "deleteBusinessSpPartnersSpPartner", "summary": "delete an existing sp-partner", "description": "delete an existing sp-partner", "input": [ { "name": "spPartnerId", "type": "string", "info": "Uniquely identifies this sp-partner by id", "required": true, "schema": { "title": "spPartnerId", "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": "/deleteBusinessSpPartnersSpPartner" }, "task": true }, { "name": "getBusinessSpPartners", "summary": "returns sp-partners", "description": "returns sp-partners", "input": [ { "name": "spPartnerId", "type": "string", "info": "", "required": false, "schema": { "title": "spPartnerId", "type": "string" } }, { "name": "url", "type": "string", "info": "", "required": false, "schema": { "title": "url", "type": "string" } }, { "name": "callsource", "type": "string", "info": "", "required": false, "schema": { "title": "callsource", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getBusinessSpPartners" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfImageUuid", "type": "string", "info": "Unique ID of this asset", "required": true, "schema": { "title": "vnfImageUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationVnfImagesVnfImage.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": "/createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfImageUuid", "type": "string", "info": "Unique ID of this asset", "required": true, "schema": { "title": "vnfImageUuid", "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": "/deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationVnfImagesVnfImage", "summary": "returns vnf-image", "description": "returns vnf-image", "input": [ { "name": "vnfImageUuid", "type": "string", "info": "Unique ID of this asset", "required": true, "schema": { "title": "vnfImageUuid", "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": "/getServiceDesignAndCreationVnfImagesVnfImage" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationVnfImagesVnfImage", "summary": "create or update an existing vnf-image", "description": "Create or update an existing vnf-image.\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": "vnfImageUuid", "type": "string", "info": "Unique ID of this asset", "required": true, "schema": { "title": "vnfImageUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationVnfImagesVnfImage.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": "/createOrUpdateServiceDesignAndCreationVnfImagesVnfImage" }, "task": true }, { "name": "updateServiceDesignAndCreationVnfImagesVnfImage", "summary": "update an existing vnf-image", "description": "Update an existing vnf-image\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": "vnfImageUuid", "type": "string", "info": "Unique ID of this asset", "required": true, "schema": { "title": "vnfImageUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "vnf-image 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": "/updateServiceDesignAndCreationVnfImagesVnfImage" }, "task": true }, { "name": "deleteServiceDesignAndCreationVnfImagesVnfImage", "summary": "delete an existing vnf-image", "description": "delete an existing vnf-image", "input": [ { "name": "vnfImageUuid", "type": "string", "info": "Unique ID of this asset", "required": true, "schema": { "title": "vnfImageUuid", "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": "/deleteServiceDesignAndCreationVnfImagesVnfImage" }, "task": true }, { "name": "getServiceDesignAndCreationVnfImages", "summary": "returns vnf-images", "description": "returns vnf-images", "input": [ { "name": "vnfImageUuid", "type": "string", "info": "", "required": false, "schema": { "title": "vnfImageUuid", "type": "string" } }, { "name": "application", "type": "string", "info": "", "required": false, "schema": { "title": "application", "type": "string" } }, { "name": "applicationVendor", "type": "string", "info": "", "required": false, "schema": { "title": "applicationVendor", "type": "string" } }, { "name": "applicationVersion", "type": "string", "info": "", "required": false, "schema": { "title": "applicationVersion", "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": "/getServiceDesignAndCreationVnfImages" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "serviceId", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServicesService.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": "/createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "serviceId", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "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": "/deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationServicesService", "summary": "returns service", "description": "returns service", "input": [ { "name": "serviceId", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "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": "/getServiceDesignAndCreationServicesService" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationServicesService", "summary": "create or update an existing service", "description": "Create or update an existing service.\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": "serviceId", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "body", "type": "object", "info": "service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServicesService.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": "/createOrUpdateServiceDesignAndCreationServicesService" }, "task": true }, { "name": "updateServiceDesignAndCreationServicesService", "summary": "update an existing service", "description": "Update an existing service\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": "serviceId", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "body", "type": "object", "info": "service 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": "/updateServiceDesignAndCreationServicesService" }, "task": true }, { "name": "deleteServiceDesignAndCreationServicesService", "summary": "delete an existing service", "description": "delete an existing service", "input": [ { "name": "serviceId", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceId", "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": "/deleteServiceDesignAndCreationServicesService" }, "task": true }, { "name": "getServiceDesignAndCreationServices", "summary": "returns services", "description": "returns services", "input": [ { "name": "serviceId", "type": "string", "info": "", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "serviceDescription", "type": "string", "info": "", "required": false, "schema": { "title": "serviceDescription", "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": "/getServiceDesignAndCreationServices" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "serviceType", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes t...(description truncated)", "required": true, "schema": { "title": "vnfType", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServiceCapabilitiesService...(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": "/createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "serviceType", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes t...(description truncated)", "required": true, "schema": { "title": "vnfType", "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": "/deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationServiceCapabilitiesServiceCapability", "summary": "returns service-capability", "description": "returns service-capability", "input": [ { "name": "serviceType", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes t...(description truncated)", "required": true, "schema": { "title": "vnfType", "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": "/getServiceDesignAndCreationServiceCapabilitiesServiceCapability" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability", "summary": "create or update an existing service-capability", "description": "Create or update an existing service-capability.\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": "serviceType", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes t...(description truncated)", "required": true, "schema": { "title": "vnfType", "type": "string" } }, { "name": "body", "type": "object", "info": "service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServiceCapabilitiesS...(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": "/createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability" }, "task": true }, { "name": "updateServiceDesignAndCreationServiceCapabilitiesServiceCapability", "summary": "update an existing service-capability", "description": "Update an existing service-capability\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 ...(description truncated)", "input": [ { "name": "serviceType", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes t...(description truncated)", "required": true, "schema": { "title": "vnfType", "type": "string" } }, { "name": "body", "type": "object", "info": "service-capability 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": "/updateServiceDesignAndCreationServiceCapabilitiesServiceCapability" }, "task": true }, { "name": "deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability", "summary": "delete an existing service-capability", "description": "delete an existing service-capability", "input": [ { "name": "serviceType", "type": "string", "info": "This gets defined by others to provide a unique ID for the service, we accept what is sent.", "required": true, "schema": { "title": "serviceType", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes t...(description truncated)", "required": true, "schema": { "title": "vnfType", "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": "/deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability" }, "task": true }, { "name": "getServiceDesignAndCreationServiceCapabilities", "summary": "returns service-capabilities", "description": "returns service-capabilities", "input": [ { "name": "serviceType", "type": "string", "info": "", "required": false, "schema": { "title": "serviceType", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "", "required": false, "schema": { "title": "vnfType", "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": "/getServiceDesignAndCreationServiceCapabilities" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "elementChoiceSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "elementChoiceSetUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelV...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "elementChoiceSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "elementChoiceSetUuid", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet", "summary": "returns element-choice-set", "description": "returns element-choice-set", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "elementChoiceSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "elementChoiceSetUuid", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet", "summary": "create or update an existing element-choice-set", "description": "Create or update an existing element-choice-set.\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "elementChoiceSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "elementChoiceSetUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVers...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet" }, "task": true }, { "name": "updateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet", "summary": "update an existing element-choice-set", "description": "Update an existing element-choice-set\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 ...(description truncated)", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "elementChoiceSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "elementChoiceSetUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "element-choice-set 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": "/updateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet", "summary": "delete an existing element-choice-set", "description": "delete an existing element-choice-set", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "elementChoiceSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "elementChoiceSetUuid", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets", "summary": "returns element-choice-sets", "description": "returns element-choice-sets", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "elementChoiceSetUuid", "type": "string", "info": "", "required": false, "schema": { "title": "elementChoiceSetUuid", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelV...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet", "summary": "returns constrained-element-set", "description": "returns constrained-element-set", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet", "summary": "create or update an existing constrained-element-set", "description": "Create or update an existing constrained-element-set.\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelMode...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet" }, "task": true }, { "name": "updateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet", "summary": "update an existing constrained-element-set", "description": "Update an existing constrained-element-set\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 ar...(description truncated)", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "constrained-element-set 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": "/updateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet", "summary": "delete an existing constrained-element-set", "description": "delete an existing constrained-element-set", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": true, "schema": { "title": "constrainedElementSetUuid", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets", "summary": "returns constrained-element-sets", "description": "returns constrained-element-sets", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "constrainedElementSetUuid", "type": "string", "info": "", "required": false, "schema": { "title": "constrainedElementSetUuid", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint", "summary": "returns model-constraint", "description": "returns model-constraint", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint", "summary": "create or update an existing model-constraint", "description": "Create or update an existing model-constraint.\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersMo...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint" }, "task": true }, { "name": "updateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint", "summary": "update an existing model-constraint", "description": "Update an existing model-constraint\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 re...(description truncated)", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "model-constraint 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": "/updateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint", "summary": "delete an existing model-constraint", "description": "delete an existing model-constraint", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelConstraintUuid", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints", "summary": "returns model-constraints", "description": "returns model-constraints", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "modelConstraintUuid", "type": "string", "info": "", "required": false, "schema": { "title": "modelConstraintUuid", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelV...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement", "summary": "returns model-element", "description": "returns model-element", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement", "summary": "create or update an existing model-element", "description": "Create or update an existing model-element.\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModel...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement" }, "task": true }, { "name": "updateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement", "summary": "update an existing model-element", "description": "Update an existing model-element\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 requi...(description truncated)", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "model-element 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": "/updateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement", "summary": "delete an existing model-element", "description": "delete an existing model-element", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "modelElementUuid", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerModelElements", "summary": "returns model-elements", "description": "returns model-elements", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelElementUuid", "type": "string", "info": "", "required": false, "schema": { "title": "modelElementUuid", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerModelElements" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum", "summary": "returns metadatum", "description": "returns metadatum", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum", "summary": "create or update an existing metadatum", "description": "Create or update an existing metadatum.\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerM...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum" }, "task": true }, { "name": "updateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum", "summary": "update an existing metadatum", "description": "Update an existing metadatum\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum 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": "/updateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum", "summary": "delete an existing metadatum", "description": "delete an existing metadatum", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVerMetadata", "summary": "returns metadata", "description": "returns metadata", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": false, "schema": { "title": "metaname", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVerMetadata" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelV...(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVersModelVer", "summary": "returns model-ver", "description": "returns model-ver", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "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": "/getServiceDesignAndCreationModelsModelModelVersModelVer" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer", "summary": "create or update an existing model-ver", "description": "Create or update an existing model-ver.\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "body", "type": "object", "info": "model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVer....(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": "/createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer" }, "task": true }, { "name": "updateServiceDesignAndCreationModelsModelModelVersModelVer", "summary": "update an existing model-ver", "description": "Update an existing model-ver\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "body", "type": "object", "info": "model-ver 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": "/updateServiceDesignAndCreationModelsModelModelVersModelVer" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelModelVersModelVer", "summary": "delete an existing model-ver", "description": "delete an existing model-ver", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "Unique identifier corresponding to one version of a model in ASDC", "required": true, "schema": { "title": "modelVersionId", "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": "/deleteServiceDesignAndCreationModelsModelModelVersModelVer" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModelModelVers", "summary": "returns model-vers", "description": "returns model-vers", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "modelName", "type": "string", "info": "", "required": false, "schema": { "title": "modelName", "type": "string" } }, { "name": "modelVersion", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersion", "type": "string" } }, { "name": "distributionStatus", "type": "string", "info": "", "required": false, "schema": { "title": "distributionStatus", "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": "/getServiceDesignAndCreationModelsModelModelVers" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModel.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": "/createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModelRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "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": "/deleteServiceDesignAndCreationModelsModelRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationModelsModel", "summary": "returns model", "description": "returns model", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "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": "/getServiceDesignAndCreationModelsModel" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationModelsModel", "summary": "create or update an existing model", "description": "Create or update an existing model.\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": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "body", "type": "object", "info": "model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModel.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": "/createOrUpdateServiceDesignAndCreationModelsModel" }, "task": true }, { "name": "updateServiceDesignAndCreationModelsModel", "summary": "update an existing model", "description": "Update an existing model\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 valu...(description truncated)", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "body", "type": "object", "info": "model 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": "/updateServiceDesignAndCreationModelsModel" }, "task": true }, { "name": "deleteServiceDesignAndCreationModelsModel", "summary": "delete an existing model", "description": "delete an existing model", "input": [ { "name": "modelInvariantId", "type": "string", "info": "Unique identifier corresponding to the main definition of a model in ASDC", "required": true, "schema": { "title": "modelInvariantId", "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": "/deleteServiceDesignAndCreationModelsModel" }, "task": true }, { "name": "getServiceDesignAndCreationModels", "summary": "returns models", "description": "returns models", "input": [ { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelType", "type": "string", "info": "", "required": false, "schema": { "title": "modelType", "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": "/getServiceDesignAndCreationModels" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "relatedLookupUuid", "type": "string", "info": "", "required": true, "schema": { "title": "relatedLookupUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryName...(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": "/createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "relatedLookupUuid", "type": "string", "info": "", "required": true, "schema": { "title": "relatedLookupUuid", "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": "/deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup", "summary": "returns related-lookup", "description": "returns related-lookup", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "relatedLookupUuid", "type": "string", "info": "", "required": true, "schema": { "title": "relatedLookupUuid", "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": "/getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup", "summary": "create or update an existing related-lookup", "description": "Create or update an existing related-lookup.\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": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "relatedLookupUuid", "type": "string", "info": "", "required": true, "schema": { "title": "relatedLookupUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNa...(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": "/createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup" }, "task": true }, { "name": "updateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup", "summary": "update an existing related-lookup", "description": "Update an existing related-lookup\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 requ...(description truncated)", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "relatedLookupUuid", "type": "string", "info": "", "required": true, "schema": { "title": "relatedLookupUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "related-lookup 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": "/updateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup" }, "task": true }, { "name": "deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup", "summary": "delete an existing related-lookup", "description": "delete an existing related-lookup", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "relatedLookupUuid", "type": "string", "info": "", "required": true, "schema": { "title": "relatedLookupUuid", "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": "/deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup" }, "task": true }, { "name": "getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups", "summary": "returns related-lookups", "description": "returns related-lookups", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "relatedLookupUuid", "type": "string", "info": "", "required": false, "schema": { "title": "relatedLookupUuid", "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": "/getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups" }, "task": true }, { "name": "getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint", "summary": "returns property-constraint", "description": "returns property-constraint", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "propertyConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "propertyConstraintUuid", "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": "/getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint", "summary": "create or update an existing property-constraint", "description": "Create or update an existing property-constraint.\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": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "propertyConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "propertyConstraintUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQu...(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": "/createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint" }, "task": true }, { "name": "updateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint", "summary": "update an existing property-constraint", "description": "Update an existing property-constraint\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...(description truncated)", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "propertyConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "propertyConstraintUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "property-constraint 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": "/updateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint" }, "task": true }, { "name": "deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint", "summary": "delete an existing property-constraint", "description": "delete an existing property-constraint", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "propertyConstraintUuid", "type": "string", "info": "", "required": true, "schema": { "title": "propertyConstraintUuid", "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": "/deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint" }, "task": true }, { "name": "getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints", "summary": "returns property-constraints", "description": "returns property-constraints", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "propertyConstraintUuid", "type": "string", "info": "", "required": false, "schema": { "title": "propertyConstraintUuid", "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": "/getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryName...(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": "/createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "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": "/deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement", "summary": "returns named-query-element", "description": "returns named-query-element", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "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": "/getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement", "summary": "create or update an existing named-query-element", "description": "Create or update an existing named-query-element.\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": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQu...(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": "/createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement" }, "task": true }, { "name": "updateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement", "summary": "update an existing named-query-element", "description": "Update an existing named-query-element\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...(description truncated)", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "named-query-element 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": "/updateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement" }, "task": true }, { "name": "deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement", "summary": "delete an existing named-query-element", "description": "delete an existing named-query-element", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryElementUuid", "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": "/deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement" }, "task": true }, { "name": "getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements", "summary": "returns named-query-elements", "description": "returns named-query-elements", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryElementUuid", "type": "string", "info": "", "required": false, "schema": { "title": "namedQueryElementUuid", "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": "/getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQuery.jso...(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": "/createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship" }, "task": true }, { "name": "deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "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": "/deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship" }, "task": true }, { "name": "getServiceDesignAndCreationNamedQueriesNamedQuery", "summary": "returns named-query", "description": "returns named-query", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "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": "/getServiceDesignAndCreationNamedQueriesNamedQuery" }, "task": true }, { "name": "createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery", "summary": "create or update an existing named-query", "description": "Create or update an existing named-query.\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": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQuery.json...(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": "/createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery" }, "task": true }, { "name": "updateServiceDesignAndCreationNamedQueriesNamedQuery", "summary": "update an existing named-query", "description": "Update an existing named-query\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 require...(description truncated)", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "named-query 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": "/updateServiceDesignAndCreationNamedQueriesNamedQuery" }, "task": true }, { "name": "deleteServiceDesignAndCreationNamedQueriesNamedQuery", "summary": "delete an existing named-query", "description": "delete an existing named-query", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": true, "schema": { "title": "namedQueryUuid", "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": "/deleteServiceDesignAndCreationNamedQueriesNamedQuery" }, "task": true }, { "name": "getServiceDesignAndCreationNamedQueries", "summary": "returns named-queries", "description": "returns named-queries", "input": [ { "name": "namedQueryUuid", "type": "string", "info": "", "required": false, "schema": { "title": "namedQueryUuid", "type": "string" } }, { "name": "namedQueryName", "type": "string", "info": "", "required": false, "schema": { "title": "namedQueryName", "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": "/getServiceDesignAndCreationNamedQueries" }, "task": true }, { "name": "createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "linkName", "type": "string", "info": "e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLogicalLinksLogicalLink.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": "/createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "linkName", "type": "string", "info": "e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ", "required": true, "schema": { "title": "linkName", "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": "/deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship" }, "task": true }, { "name": "getNetworkLogicalLinksLogicalLink", "summary": "returns logical-link", "description": "returns logical-link", "input": [ { "name": "linkName", "type": "string", "info": "e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ", "required": true, "schema": { "title": "linkName", "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": "/getNetworkLogicalLinksLogicalLink" }, "task": true }, { "name": "createOrUpdateNetworkLogicalLinksLogicalLink", "summary": "create or update an existing logical-link", "description": "Create or update an existing logical-link.\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": "linkName", "type": "string", "info": "e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLogicalLinksLogicalLink.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": "/createOrUpdateNetworkLogicalLinksLogicalLink" }, "task": true }, { "name": "updateNetworkLogicalLinksLogicalLink", "summary": "update an existing logical-link", "description": "Update an existing logical-link\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 requir...(description truncated)", "input": [ { "name": "linkName", "type": "string", "info": "e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "logical-link 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": "/updateNetworkLogicalLinksLogicalLink" }, "task": true }, { "name": "deleteNetworkLogicalLinksLogicalLink", "summary": "delete an existing logical-link", "description": "delete an existing logical-link", "input": [ { "name": "linkName", "type": "string", "info": "e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ", "required": true, "schema": { "title": "linkName", "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": "/deleteNetworkLogicalLinksLogicalLink" }, "task": true }, { "name": "getNetworkLogicalLinks", "summary": "returns logical-links", "description": "returns logical-links", "input": [ { "name": "linkName", "type": "string", "info": "", "required": false, "schema": { "title": "linkName", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "widgetModelId", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelId", "type": "string" } }, { "name": "widgetModelVersion", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelVersion", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "linkId", "type": "string", "info": "", "required": false, "schema": { "title": "linkId", "type": "string" } }, { "name": "circuitId", "type": "string", "info": "", "required": false, "schema": { "title": "circuitId", "type": "string" } }, { "name": "purpose", "type": "string", "info": "", "required": false, "schema": { "title": "purpose", "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": "/getNetworkLogicalLinks" }, "task": true }, { "name": "createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "cos", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "cos", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRout...(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": "/createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "cos", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "cos", "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": "/deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship" }, "task": true }, { "name": "getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService", "summary": "returns class-of-service", "description": "returns class-of-service", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "cos", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "cos", "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": "/getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService" }, "task": true }, { "name": "createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService", "summary": "create or update an existing class-of-service", "description": "Create or update an existing class-of-service.\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": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "cos", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "cos", "type": "string" } }, { "name": "body", "type": "object", "info": "class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstances...(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": "/createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService" }, "task": true }, { "name": "updateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService", "summary": "update an existing class-of-service", "description": "Update an existing class-of-service\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 re...(description truncated)", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "cos", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "cos", "type": "string" } }, { "name": "body", "type": "object", "info": "class-of-service 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": "/updateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService" }, "task": true }, { "name": "deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService", "summary": "delete an existing class-of-service", "description": "delete an existing class-of-service", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "cos", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "cos", "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": "/deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService" }, "task": true }, { "name": "getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService", "summary": "returns classes-of-service", "description": "returns classes-of-service", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "cos", "type": "string", "info": "", "required": false, "schema": { "title": "cos", "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": "/getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService" }, "task": true }, { "name": "createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRout...(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": "/createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "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": "/deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship" }, "task": true }, { "name": "getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair", "summary": "returns site-pair", "description": "returns site-pair", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "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": "/getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair" }, "task": true }, { "name": "createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair", "summary": "create or update an existing site-pair", "description": "Create or update an existing site-pair.\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": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "body", "type": "object", "info": "site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRouting...(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": "/createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair" }, "task": true }, { "name": "updateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair", "summary": "update an existing site-pair", "description": "Update an existing site-pair\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": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "type": "string" } }, { "name": "body", "type": "object", "info": "site-pair 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": "/updateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair" }, "task": true }, { "name": "deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair", "summary": "delete an existing site-pair", "description": "delete an existing site-pair", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "unique identifier of probe", "required": true, "schema": { "title": "sitePairId", "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": "/deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair" }, "task": true }, { "name": "getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs", "summary": "returns site-pairs", "description": "returns site-pairs", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "sitePairId", "type": "string", "info": "", "required": false, "schema": { "title": "sitePairId", "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": "/getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs" }, "task": true }, { "name": "createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRout...(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": "/createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "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": "/deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship" }, "task": true }, { "name": "getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance", "summary": "returns routing-instance", "description": "returns routing-instance", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "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": "/getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance" }, "task": true }, { "name": "createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance", "summary": "create or update an existing routing-instance", "description": "Create or update an existing routing-instance.\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": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstances...(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": "/createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance" }, "task": true }, { "name": "updateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance", "summary": "update an existing routing-instance", "description": "Update an existing routing-instance\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 re...(description truncated)", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "routing-instance 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": "/updateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance" }, "task": true }, { "name": "deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance", "summary": "delete an existing routing-instance", "description": "delete an existing routing-instance", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "Unique id of routing instance", "required": true, "schema": { "title": "routingInstanceId", "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": "/deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance" }, "task": true }, { "name": "getNetworkSitePairSetsSitePairSetRoutingInstances", "summary": "returns routing-instances", "description": "returns routing-instances", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "routingInstanceId", "type": "string", "info": "", "required": false, "schema": { "title": "routingInstanceId", "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": "/getNetworkSitePairSetsSitePairSetRoutingInstances" }, "task": true }, { "name": "createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSet.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": "/createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "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": "/deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship" }, "task": true }, { "name": "getNetworkSitePairSetsSitePairSet", "summary": "returns site-pair-set", "description": "returns site-pair-set", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "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": "/getNetworkSitePairSetsSitePairSet" }, "task": true }, { "name": "createOrUpdateNetworkSitePairSetsSitePairSet", "summary": "create or update an existing site-pair-set", "description": "Create or update an existing site-pair-set.\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": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "body", "type": "object", "info": "site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSet.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": "/createOrUpdateNetworkSitePairSetsSitePairSet" }, "task": true }, { "name": "updateNetworkSitePairSetsSitePairSet", "summary": "update an existing site-pair-set", "description": "Update an existing site-pair-set\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 requi...(description truncated)", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "type": "string" } }, { "name": "body", "type": "object", "info": "site-pair-set 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": "/updateNetworkSitePairSetsSitePairSet" }, "task": true }, { "name": "deleteNetworkSitePairSetsSitePairSet", "summary": "delete an existing site-pair-set", "description": "delete an existing site-pair-set", "input": [ { "name": "sitePairSetId", "type": "string", "info": "Unique id of site pair set.", "required": true, "schema": { "title": "sitePairSetId", "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": "/deleteNetworkSitePairSetsSitePairSet" }, "task": true }, { "name": "getNetworkSitePairSets", "summary": "returns site-pair-sets", "description": "returns site-pair-sets", "input": [ { "name": "sitePairSetId", "type": "string", "info": "", "required": false, "schema": { "title": "sitePairSetId", "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": "/getNetworkSitePairSets" }, "task": true }, { "name": "createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarge...(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": "/createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "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": "/deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget", "summary": "returns route-target", "description": "returns route-target", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "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": "/getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget" }, "task": true }, { "name": "createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget", "summary": "create or update an existing route-target", "description": "Create or update an existing route-target.\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": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "type": "string" } }, { "name": "body", "type": "object", "info": "route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarge...(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": "/createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget" }, "task": true }, { "name": "updateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget", "summary": "update an existing route-target", "description": "Update an existing route-target\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 requir...(description truncated)", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "type": "string" } }, { "name": "body", "type": "object", "info": "route-target 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": "/updateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget" }, "task": true }, { "name": "deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget", "summary": "delete an existing route-target", "description": "delete an existing route-target", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "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": "/deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget" }, "task": true }, { "name": "getNetworkVpnBindingsVpnBindingRouteTargets", "summary": "returns route-targets", "description": "returns route-targets", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "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": "/getNetworkVpnBindingsVpnBindingRouteTargets" }, "task": true }, { "name": "createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBinding.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": "/createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "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": "/deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVpnBindingsVpnBinding", "summary": "returns vpn-binding", "description": "returns vpn-binding", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "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": "/getNetworkVpnBindingsVpnBinding" }, "task": true }, { "name": "createOrUpdateNetworkVpnBindingsVpnBinding", "summary": "create or update an existing vpn-binding", "description": "Create or update an existing vpn-binding.\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": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "body", "type": "object", "info": "vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBinding.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": "/createOrUpdateNetworkVpnBindingsVpnBinding" }, "task": true }, { "name": "updateNetworkVpnBindingsVpnBinding", "summary": "update an existing vpn-binding", "description": "Update an existing vpn-binding\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 require...(description truncated)", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "type": "string" } }, { "name": "body", "type": "object", "info": "vpn-binding 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": "/updateNetworkVpnBindingsVpnBinding" }, "task": true }, { "name": "deleteNetworkVpnBindingsVpnBinding", "summary": "delete an existing vpn-binding", "description": "delete an existing vpn-binding", "input": [ { "name": "vpnId", "type": "string", "info": "VPN ID, globally unique within A&AI", "required": true, "schema": { "title": "vpnId", "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": "/deleteNetworkVpnBindingsVpnBinding" }, "task": true }, { "name": "getNetworkVpnBindings", "summary": "returns vpn-bindings", "description": "returns vpn-bindings", "input": [ { "name": "vpnId", "type": "string", "info": "", "required": false, "schema": { "title": "vpnId", "type": "string" } }, { "name": "vpnName", "type": "string", "info": "", "required": false, "schema": { "title": "vpnName", "type": "string" } }, { "name": "vpnType", "type": "string", "info": "", "required": false, "schema": { "title": "vpnType", "type": "string" } }, { "name": "accessProviderId", "type": "string", "info": "", "required": false, "schema": { "title": "accessProviderId", "type": "string" } }, { "name": "accessClientId", "type": "string", "info": "", "required": false, "schema": { "title": "accessClientId", "type": "string" } }, { "name": "accessTopologyId", "type": "string", "info": "", "required": false, "schema": { "title": "accessTopologyId", "type": "string" } }, { "name": "srcAccessNodeId", "type": "string", "info": "", "required": false, "schema": { "title": "srcAccessNodeId", "type": "string" } }, { "name": "srcAccessLtpId", "type": "string", "info": "", "required": false, "schema": { "title": "srcAccessLtpId", "type": "string" } }, { "name": "dstAccessNodeId", "type": "string", "info": "", "required": false, "schema": { "title": "dstAccessNodeId", "type": "string" } }, { "name": "dstAccessLtpId", "type": "string", "info": "", "required": false, "schema": { "title": "dstAccessLtpId", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkVpnBindings" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPe.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": "/createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "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": "/deleteNetworkVplsPesVplsPeRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterface.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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsS...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf", "summary": "returns sriov-pf", "description": "returns sriov-pf", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf", "summary": "create or update an existing sriov-pf", "description": "Create or update an existing sriov-pf.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriov...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf", "summary": "update an existing sriov-pf", "description": "Update an existing sriov-pf\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 v...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-pf 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": "/updateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf", "summary": "delete an existing sriov-pf", "description": "delete an existing sriov-pf", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs", "summary": "returns sriov-pfs", "description": "returns sriov-pfs", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "", "required": false, "schema": { "title": "pfPciId", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfac...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfac...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesP...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfac...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesP...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInter...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfac...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLI...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfac...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfac...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesP...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfac...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesP...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterface...(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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNameQuery", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceNameQuery", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfacesPInterface", "summary": "returns p-interface", "description": "returns p-interface", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/getNetworkVplsPesVplsPePInterfacesPInterface" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface", "summary": "create or update an existing p-interface", "description": "Create or update an existing p-interface.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterface.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": "/createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface" }, "task": true }, { "name": "updateNetworkVplsPesVplsPePInterfacesPInterface", "summary": "update an existing p-interface", "description": "Update an existing p-interface\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 require...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "p-interface 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": "/updateNetworkVplsPesVplsPePInterfacesPInterface" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPePInterfacesPInterface", "summary": "delete an existing p-interface", "description": "delete an existing p-interface", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkVplsPesVplsPePInterfacesPInterface" }, "task": true }, { "name": "getNetworkVplsPesVplsPePInterfaces", "summary": "returns p-interfaces", "description": "returns p-interfaces", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "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": "/getNetworkVplsPesVplsPePInterfaces" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterface.json...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInte...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInte...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterface...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInte...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterface...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLI...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInte...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfac...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInte...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInte...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterface...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInte...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterface...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInter...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNameQuery", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceNameQuery", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfacesLagInterface", "summary": "returns lag-interface", "description": "returns lag-interface", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/getNetworkVplsPesVplsPeLagInterfacesLagInterface" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface", "summary": "create or update an existing lag-interface", "description": "Create or update an existing lag-interface.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterface.jso...(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": "/createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface" }, "task": true }, { "name": "updateNetworkVplsPesVplsPeLagInterfacesLagInterface", "summary": "update an existing lag-interface", "description": "Update an existing lag-interface\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 requi...(description truncated)", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-interface 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": "/updateNetworkVplsPesVplsPeLagInterfacesLagInterface" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPeLagInterfacesLagInterface", "summary": "delete an existing lag-interface", "description": "delete an existing lag-interface", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkVplsPesVplsPeLagInterfacesLagInterface" }, "task": true }, { "name": "getNetworkVplsPesVplsPeLagInterfaces", "summary": "returns lag-interfaces", "description": "returns lag-interfaces", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "interfaceRole", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceRole", "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": "/getNetworkVplsPesVplsPeLagInterfaces" }, "task": true }, { "name": "getNetworkVplsPesVplsPe", "summary": "returns vpls-pe", "description": "returns vpls-pe", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "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": "/getNetworkVplsPesVplsPe" }, "task": true }, { "name": "createOrUpdateNetworkVplsPesVplsPe", "summary": "create or update an existing vpls-pe", "description": "Create or update an existing vpls-pe.\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "body", "type": "object", "info": "vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPe.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": "/createOrUpdateNetworkVplsPesVplsPe" }, "task": true }, { "name": "updateNetworkVplsPesVplsPe", "summary": "update an existing vpls-pe", "description": "Update an existing vpls-pe\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": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "body", "type": "object", "info": "vpls-pe 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": "/updateNetworkVplsPesVplsPe" }, "task": true }, { "name": "deleteNetworkVplsPesVplsPe", "summary": "delete an existing vpls-pe", "description": "delete an existing vpls-pe", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": true, "schema": { "title": "equipmentName", "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": "/deleteNetworkVplsPesVplsPe" }, "task": true }, { "name": "getNetworkVplsPes", "summary": "returns vpls-pes", "description": "returns vpls-pes", "input": [ { "name": "equipmentName", "type": "string", "info": "", "required": false, "schema": { "title": "equipmentName", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "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": "/getNetworkVplsPes" }, "task": true }, { "name": "createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "multicastConfigurationId", "type": "string", "info": "Unique id of multicast configuration.", "required": true, "schema": { "title": "multicastConfigurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkMulticastConfigurationsMulticastConfigurati...(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": "/createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "multicastConfigurationId", "type": "string", "info": "Unique id of multicast configuration.", "required": true, "schema": { "title": "multicastConfigurationId", "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": "/deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship" }, "task": true }, { "name": "getNetworkMulticastConfigurationsMulticastConfiguration", "summary": "returns multicast-configuration", "description": "returns multicast-configuration", "input": [ { "name": "multicastConfigurationId", "type": "string", "info": "Unique id of multicast configuration.", "required": true, "schema": { "title": "multicastConfigurationId", "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": "/getNetworkMulticastConfigurationsMulticastConfiguration" }, "task": true }, { "name": "createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration", "summary": "create or update an existing multicast-configuration", "description": "Create or update an existing multicast-configuration.\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": "multicastConfigurationId", "type": "string", "info": "Unique id of multicast configuration.", "required": true, "schema": { "title": "multicastConfigurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkMulticastConfigurationsMulticast...(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": "/createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration" }, "task": true }, { "name": "updateNetworkMulticastConfigurationsMulticastConfiguration", "summary": "update an existing multicast-configuration", "description": "Update an existing multicast-configuration\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 ar...(description truncated)", "input": [ { "name": "multicastConfigurationId", "type": "string", "info": "Unique id of multicast configuration.", "required": true, "schema": { "title": "multicastConfigurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "multicast-configuration 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": "/updateNetworkMulticastConfigurationsMulticastConfiguration" }, "task": true }, { "name": "deleteNetworkMulticastConfigurationsMulticastConfiguration", "summary": "delete an existing multicast-configuration", "description": "delete an existing multicast-configuration", "input": [ { "name": "multicastConfigurationId", "type": "string", "info": "Unique id of multicast configuration.", "required": true, "schema": { "title": "multicastConfigurationId", "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": "/deleteNetworkMulticastConfigurationsMulticastConfiguration" }, "task": true }, { "name": "getNetworkMulticastConfigurations", "summary": "returns multicast-configurations", "description": "returns multicast-configurations", "input": [ { "name": "multicastConfigurationId", "type": "string", "info": "", "required": false, "schema": { "title": "multicastConfigurationId", "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": "/getNetworkMulticastConfigurations" }, "task": true }, { "name": "createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "cvlanTag", "type": "number", "info": "See mis-na-virtualization-platform.yang", "required": true, "schema": { "title": "cvlanTag", "type": "number" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTag...(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": "/createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "cvlanTag", "type": "number", "info": "See mis-na-virtualization-platform.yang", "required": true, "schema": { "title": "cvlanTag", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry", "summary": "returns cvlan-tag-entry", "description": "returns cvlan-tag-entry", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "cvlanTag", "type": "number", "info": "See mis-na-virtualization-platform.yang", "required": true, "schema": { "title": "cvlanTag", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry" }, "task": true }, { "name": "createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry", "summary": "create or update an existing cvlan-tag-entry", "description": "Create or update an existing cvlan-tag-entry.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "cvlanTag", "type": "number", "info": "See mis-na-virtualization-platform.yang", "required": true, "schema": { "title": "cvlanTag", "type": "number" } }, { "name": "body", "type": "object", "info": "cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlan...(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": "/createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry" }, "task": true }, { "name": "updateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry", "summary": "update an existing cvlan-tag-entry", "description": "Update an existing cvlan-tag-entry\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 req...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "cvlanTag", "type": "number", "info": "See mis-na-virtualization-platform.yang", "required": true, "schema": { "title": "cvlanTag", "type": "number" } }, { "name": "body", "type": "object", "info": "cvlan-tag-entry 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": "/updateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry" }, "task": true }, { "name": "deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry", "summary": "delete an existing cvlan-tag-entry", "description": "delete an existing cvlan-tag-entry", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "cvlanTag", "type": "number", "info": "See mis-na-virtualization-platform.yang", "required": true, "schema": { "title": "cvlanTag", "type": "number" } }, { "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": "/deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry" }, "task": true }, { "name": "getNetworkVcesVcePortGroupsPortGroupCvlanTags", "summary": "returns cvlan-tags", "description": "returns cvlan-tags", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "cvlanTag", "type": "number", "info": "", "required": false, "schema": { "title": "cvlanTag", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworkVcesVcePortGroupsPortGroupCvlanTags" }, "task": true }, { "name": "createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroup.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": "/createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "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": "/deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVcesVcePortGroupsPortGroup", "summary": "returns port-group", "description": "returns port-group", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "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": "/getNetworkVcesVcePortGroupsPortGroup" }, "task": true }, { "name": "createOrUpdateNetworkVcesVcePortGroupsPortGroup", "summary": "create or update an existing port-group", "description": "Create or update an existing port-group.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "body", "type": "object", "info": "port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroup.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": "/createOrUpdateNetworkVcesVcePortGroupsPortGroup" }, "task": true }, { "name": "updateNetworkVcesVcePortGroupsPortGroup", "summary": "update an existing port-group", "description": "Update an existing port-group\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "body", "type": "object", "info": "port-group 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": "/updateNetworkVcesVcePortGroupsPortGroup" }, "task": true }, { "name": "deleteNetworkVcesVcePortGroupsPortGroup", "summary": "delete an existing port-group", "description": "delete an existing port-group", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "Unique ID of the interface", "required": true, "schema": { "title": "interfaceId", "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": "/deleteNetworkVcesVcePortGroupsPortGroup" }, "task": true }, { "name": "getNetworkVcesVcePortGroups", "summary": "returns port-groups", "description": "returns port-groups", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "portGroupId", "type": "string", "info": "", "required": false, "schema": { "title": "portGroupId", "type": "string" } }, { "name": "switchName", "type": "string", "info": "", "required": false, "schema": { "title": "switchName", "type": "string" } }, { "name": "heatStackId", "type": "string", "info": "", "required": false, "schema": { "title": "heatStackId", "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": "/getNetworkVcesVcePortGroups" }, "task": true }, { "name": "createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceLicensesLicense.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": "/createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVcesVceLicensesLicense", "summary": "returns license", "description": "returns license", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/getNetworkVcesVceLicensesLicense" }, "task": true }, { "name": "createOrUpdateNetworkVcesVceLicensesLicense", "summary": "create or update an existing license", "description": "Create or update an existing license.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceLicensesLicense.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": "/createOrUpdateNetworkVcesVceLicensesLicense" }, "task": true }, { "name": "updateNetworkVcesVceLicensesLicense", "summary": "update an existing license", "description": "Update an existing license\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "license 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": "/updateNetworkVcesVceLicensesLicense" }, "task": true }, { "name": "deleteNetworkVcesVceLicensesLicense", "summary": "delete an existing license", "description": "delete an existing license", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/deleteNetworkVcesVceLicensesLicense" }, "task": true }, { "name": "getNetworkVcesVceLicenses", "summary": "returns licenses", "description": "returns licenses", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "", "required": false, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "", "required": false, "schema": { "title": "resourceUuid", "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": "/getNetworkVcesVceLicenses" }, "task": true }, { "name": "createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceEntitlementsEntitlement.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": "/createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVcesVceEntitlementsEntitlement", "summary": "returns entitlement", "description": "returns entitlement", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/getNetworkVcesVceEntitlementsEntitlement" }, "task": true }, { "name": "createOrUpdateNetworkVcesVceEntitlementsEntitlement", "summary": "create or update an existing entitlement", "description": "Create or update an existing entitlement.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceEntitlementsEntitlement.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": "/createOrUpdateNetworkVcesVceEntitlementsEntitlement" }, "task": true }, { "name": "updateNetworkVcesVceEntitlementsEntitlement", "summary": "update an existing entitlement", "description": "Update an existing entitlement\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 require...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "entitlement 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": "/updateNetworkVcesVceEntitlementsEntitlement" }, "task": true }, { "name": "deleteNetworkVcesVceEntitlementsEntitlement", "summary": "delete an existing entitlement", "description": "delete an existing entitlement", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/deleteNetworkVcesVceEntitlementsEntitlement" }, "task": true }, { "name": "getNetworkVcesVceEntitlements", "summary": "returns entitlements", "description": "returns entitlements", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "", "required": false, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "", "required": false, "schema": { "title": "resourceUuid", "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": "/getNetworkVcesVceEntitlements" }, "task": true }, { "name": "createOrUpdateNetworkVcesVceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVce.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": "/createOrUpdateNetworkVcesVceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVcesVceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "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": "/deleteNetworkVcesVceRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVcesVce", "summary": "returns vce", "description": "returns vce", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "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": "/getNetworkVcesVce" }, "task": true }, { "name": "createOrUpdateNetworkVcesVce", "summary": "create or update an existing vce", "description": "Create or update an existing vce.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "body", "type": "object", "info": "vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVce.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": "/createOrUpdateNetworkVcesVce" }, "task": true }, { "name": "updateNetworkVcesVce", "summary": "update an existing vce", "description": "Update an existing vce\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 values...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "body", "type": "object", "info": "vce 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": "/updateNetworkVcesVce" }, "task": true }, { "name": "deleteNetworkVcesVce", "summary": "delete an existing vce", "description": "delete an existing vce", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "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": "/deleteNetworkVcesVce" }, "task": true }, { "name": "getNetworkVces", "summary": "returns vces", "description": "returns vces", "input": [ { "name": "vnfId", "type": "string", "info": "", "required": false, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vnfName", "type": "string", "info": "", "required": false, "schema": { "title": "vnfName", "type": "string" } }, { "name": "vnfName2", "type": "string", "info": "", "required": false, "schema": { "title": "vnfName2", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "", "required": false, "schema": { "title": "vnfType", "type": "string" } }, { "name": "serviceId", "type": "string", "info": "", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "regionalResourceZone", "type": "string", "info": "", "required": false, "schema": { "title": "regionalResourceZone", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "heatStackId", "type": "string", "info": "", "required": false, "schema": { "title": "heatStackId", "type": "string" } }, { "name": "vpeId", "type": "string", "info": "", "required": false, "schema": { "title": "vpeId", "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": "/getNetworkVces" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfc.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": "/createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "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": "/deleteNetworkVnfcsVnfcRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcCpsCpRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCp.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": "/createOrUpdateNetworkVnfcsVnfcCpsCpRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcCpsCpRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "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": "/deleteNetworkVnfcsVnfcCpsCpRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList.js...(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": "/createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3Interface...(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": "/createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList.js...(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": "/createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3Interface...(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": "/createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkVnfcsVnfcCpsCp", "summary": "returns cp", "description": "returns cp", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "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": "/getNetworkVnfcsVnfcCpsCp" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcCpsCp", "summary": "create or update an existing cp", "description": "Create or update an existing cp.\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": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "cp object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCp.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": "/createOrUpdateNetworkVnfcsVnfcCpsCp" }, "task": true }, { "name": "updateNetworkVnfcsVnfcCpsCp", "summary": "update an existing cp", "description": "Update an existing cp\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 values....(description truncated)", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "type": "string" } }, { "name": "body", "type": "object", "info": "cp 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": "/updateNetworkVnfcsVnfcCpsCp" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcCpsCp", "summary": "delete an existing cp", "description": "delete an existing cp", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "cpInstanceId", "type": "string", "info": "Unique ID of the connection point.", "required": true, "schema": { "title": "cpInstanceId", "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": "/deleteNetworkVnfcsVnfcCpsCp" }, "task": true }, { "name": "getNetworkVnfcsVnfcCps", "summary": "returns cps", "description": "returns cps", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "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": "/getNetworkVnfcsVnfcCps" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.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": "/createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVnfcsVnfcL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkVnfcsVnfcL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv4A...(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": "/createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkVnfcsVnfcL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkVnfcsVnfcL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.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": "/createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVnfcsVnfcL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkVnfcsVnfcL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv6A...(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": "/createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkVnfcsVnfcL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkVnfcsVnfcL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkVnfcsVnfc", "summary": "returns vnfc", "description": "returns vnfc", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "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": "/getNetworkVnfcsVnfc" }, "task": true }, { "name": "createOrUpdateNetworkVnfcsVnfc", "summary": "create or update an existing vnfc", "description": "Create or update an existing vnfc.\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": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "body", "type": "object", "info": "vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfc.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": "/createOrUpdateNetworkVnfcsVnfc" }, "task": true }, { "name": "updateNetworkVnfcsVnfc", "summary": "update an existing vnfc", "description": "Update an existing vnfc\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 value...(description truncated)", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "body", "type": "object", "info": "vnfc 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": "/updateNetworkVnfcsVnfc" }, "task": true }, { "name": "deleteNetworkVnfcsVnfc", "summary": "delete an existing vnfc", "description": "delete an existing vnfc", "input": [ { "name": "vnfcName", "type": "string", "info": "Unique ID of vnfc.", "required": true, "schema": { "title": "vnfcName", "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": "/deleteNetworkVnfcsVnfc" }, "task": true }, { "name": "getNetworkVnfcs", "summary": "returns vnfcs", "description": "returns vnfcs", "input": [ { "name": "vnfcName", "type": "string", "info": "", "required": false, "schema": { "title": "vnfcName", "type": "string" } }, { "name": "nfcNamingCode", "type": "string", "info": "", "required": false, "schema": { "title": "nfcNamingCode", "type": "string" } }, { "name": "nfcFunction", "type": "string", "info": "", "required": false, "schema": { "title": "nfcFunction", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "ipaddressV4OamVip", "type": "string", "info": "", "required": false, "schema": { "title": "ipaddressV4OamVip", "type": "string" } }, { "name": "inMaint", "type": "boolean", "info": "", "required": false, "schema": { "title": "inMaint", "type": "boolean" } }, { "name": "isClosedLoopDisabled", "type": "boolean", "info": "", "required": false, "schema": { "title": "isClosedLoopDisabled", "type": "boolean" } }, { "name": "groupNotation", "type": "string", "info": "", "required": false, "schema": { "title": "groupNotation", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkVnfcs" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "hostRouteId", "type": "string", "info": "host-route id", "required": true, "schema": { "title": "hostRouteId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesH...(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": "/createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "hostRouteId", "type": "string", "info": "host-route id", "required": true, "schema": { "title": "hostRouteId", "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": "/deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute", "summary": "returns host-route", "description": "returns host-route", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "hostRouteId", "type": "string", "info": "host-route id", "required": true, "schema": { "title": "hostRouteId", "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": "/getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute", "summary": "create or update an existing host-route", "description": "Create or update an existing host-route.\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": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "hostRouteId", "type": "string", "info": "host-route id", "required": true, "schema": { "title": "hostRouteId", "type": "string" } }, { "name": "body", "type": "object", "info": "host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHos...(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": "/createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute" }, "task": true }, { "name": "updateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute", "summary": "update an existing host-route", "description": "Update an existing host-route\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": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "hostRouteId", "type": "string", "info": "host-route id", "required": true, "schema": { "title": "hostRouteId", "type": "string" } }, { "name": "body", "type": "object", "info": "host-route 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": "/updateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute", "summary": "delete an existing host-route", "description": "delete an existing host-route", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "hostRouteId", "type": "string", "info": "host-route id", "required": true, "schema": { "title": "hostRouteId", "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": "/deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes", "summary": "returns host-routes", "description": "returns host-routes", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "hostRouteId", "type": "string", "info": "", "required": false, "schema": { "title": "hostRouteId", "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": "/getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnet.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": "/createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "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": "/deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkSubnetsSubnet", "summary": "returns subnet", "description": "returns subnet", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "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": "/getNetworkL3NetworksL3NetworkSubnetsSubnet" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet", "summary": "create or update an existing subnet", "description": "Create or update an existing subnet.\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": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "body", "type": "object", "info": "subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnet.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": "/createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet" }, "task": true }, { "name": "updateNetworkL3NetworksL3NetworkSubnetsSubnet", "summary": "update an existing subnet", "description": "Update an existing subnet\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 val...(description truncated)", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "body", "type": "object", "info": "subnet 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": "/updateNetworkL3NetworksL3NetworkSubnetsSubnet" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkSubnetsSubnet", "summary": "delete an existing subnet", "description": "delete an existing subnet", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "Subnet ID, should be UUID.", "required": true, "schema": { "title": "subnetId", "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": "/deleteNetworkL3NetworksL3NetworkSubnetsSubnet" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkSubnets", "summary": "returns subnets", "description": "returns subnets", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "subnetId", "type": "string", "info": "", "required": false, "schema": { "title": "subnetId", "type": "string" } }, { "name": "subnetName", "type": "string", "info": "", "required": false, "schema": { "title": "subnetName", "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": "/getNetworkL3NetworksL3NetworkSubnets" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "id.", "required": true, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssig...(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": "/createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "id.", "required": true, "schema": { "title": "vlanIdInner", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment", "summary": "returns ctag-assignment", "description": "returns ctag-assignment", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "id.", "required": true, "schema": { "title": "vlanIdInner", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment", "summary": "create or update an existing ctag-assignment", "description": "Create or update an existing ctag-assignment.\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": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "id.", "required": true, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "body", "type": "object", "info": "ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAs...(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": "/createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment" }, "task": true }, { "name": "updateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment", "summary": "update an existing ctag-assignment", "description": "Update an existing ctag-assignment\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 req...(description truncated)", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "id.", "required": true, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "body", "type": "object", "info": "ctag-assignment 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": "/updateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment", "summary": "delete an existing ctag-assignment", "description": "delete an existing ctag-assignment", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "id.", "required": true, "schema": { "title": "vlanIdInner", "type": "number" } }, { "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": "/deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkCtagAssignments", "summary": "returns ctag-assignments", "description": "returns ctag-assignments", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworkL3NetworksL3NetworkCtagAssignments" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "segmentationId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "segmentationId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSegmentationAssignmentsS...(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": "/createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "segmentationId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "segmentationId", "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": "/deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment", "summary": "returns segmentation-assignment", "description": "returns segmentation-assignment", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "segmentationId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "segmentationId", "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": "/getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment", "summary": "create or update an existing segmentation-assignment", "description": "Create or update an existing segmentation-assignment.\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": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "segmentationId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "segmentationId", "type": "string" } }, { "name": "body", "type": "object", "info": "segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSegmentationA...(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": "/createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment" }, "task": true }, { "name": "updateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment", "summary": "update an existing segmentation-assignment", "description": "Update an existing segmentation-assignment\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 ar...(description truncated)", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "segmentationId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "segmentationId", "type": "string" } }, { "name": "body", "type": "object", "info": "segmentation-assignment 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": "/updateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment", "summary": "delete an existing segmentation-assignment", "description": "delete an existing segmentation-assignment", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "segmentationId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "segmentationId", "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": "/deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkSegmentationAssignments", "summary": "returns segmentation-assignments", "description": "returns segmentation-assignments", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "segmentationId", "type": "string", "info": "", "required": false, "schema": { "title": "segmentationId", "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": "/getNetworkL3NetworksL3NetworkSegmentationAssignments" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRouteRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "routeId", "type": "string", "info": "Unique id of the aggregate-route instance", "required": true, "schema": { "title": "routeId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkAggregateRoutesAggregate...(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": "/createOrUpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRouteRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkAggregateRoutesAggregateRouteRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "routeId", "type": "string", "info": "Unique id of the aggregate-route instance", "required": true, "schema": { "title": "routeId", "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": "/deleteNetworkL3NetworksL3NetworkAggregateRoutesAggregateRouteRelationshipListRelationship" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute", "summary": "returns aggregate-route", "description": "returns aggregate-route", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "routeId", "type": "string", "info": "Unique id of the aggregate-route instance", "required": true, "schema": { "title": "routeId", "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": "/getNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute", "summary": "create or update an existing aggregate-route", "description": "Create or update an existing aggregate-route.\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": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "routeId", "type": "string", "info": "Unique id of the aggregate-route instance", "required": true, "schema": { "title": "routeId", "type": "string" } }, { "name": "body", "type": "object", "info": "aggregate-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkAggregateRoutesAggreg...(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": "/createOrUpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute" }, "task": true }, { "name": "updateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute", "summary": "update an existing aggregate-route", "description": "Update an existing aggregate-route\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 req...(description truncated)", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "routeId", "type": "string", "info": "Unique id of the aggregate-route instance", "required": true, "schema": { "title": "routeId", "type": "string" } }, { "name": "body", "type": "object", "info": "aggregate-route 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": "/updateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute", "summary": "delete an existing aggregate-route", "description": "delete an existing aggregate-route", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "routeId", "type": "string", "info": "Unique id of the aggregate-route instance", "required": true, "schema": { "title": "routeId", "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": "/deleteNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute" }, "task": true }, { "name": "getNetworkL3NetworksL3NetworkAggregateRoutes", "summary": "returns aggregate-routes", "description": "returns aggregate-routes", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "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": "/getNetworkL3NetworksL3NetworkAggregateRoutes" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3Network.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": "/createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkL3NetworksL3NetworkRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "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": "/deleteNetworkL3NetworksL3NetworkRelationshipListRelationship" }, "task": true }, { "name": "getNetworkL3NetworksL3Network", "summary": "returns l3-network", "description": "returns l3-network", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "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": "/getNetworkL3NetworksL3Network" }, "task": true }, { "name": "createOrUpdateNetworkL3NetworksL3Network", "summary": "create or update an existing l3-network", "description": "Create or update an existing l3-network.\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": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3Network.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": "/createOrUpdateNetworkL3NetworksL3Network" }, "task": true }, { "name": "updateNetworkL3NetworksL3Network", "summary": "update an existing l3-network", "description": "Update an existing l3-network\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": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-network 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": "/updateNetworkL3NetworksL3Network" }, "task": true }, { "name": "deleteNetworkL3NetworksL3Network", "summary": "delete an existing l3-network", "description": "delete an existing l3-network", "input": [ { "name": "networkId", "type": "string", "info": "Network ID, should be uuid. Unique across A&AI.", "required": true, "schema": { "title": "networkId", "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": "/deleteNetworkL3NetworksL3Network" }, "task": true }, { "name": "getNetworkL3Networks", "summary": "returns l3-networks", "description": "returns l3-networks", "input": [ { "name": "networkId", "type": "string", "info": "", "required": false, "schema": { "title": "networkId", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "type": "string" } }, { "name": "networkRole", "type": "string", "info": "", "required": false, "schema": { "title": "networkRole", "type": "string" } }, { "name": "serviceId", "type": "string", "info": "", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "heatStackId", "type": "string", "info": "", "required": false, "schema": { "title": "heatStackId", "type": "string" } }, { "name": "contrailNetworkFqdn", "type": "string", "info": "", "required": false, "schema": { "title": "contrailNetworkFqdn", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "widgetModelId", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelId", "type": "string" } }, { "name": "widgetModelVersion", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelVersion", "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": "/getNetworkL3Networks" }, "task": true }, { "name": "createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkPolicyId", "type": "string", "info": "UUID representing unique key to this instance", "required": true, "schema": { "title": "networkPolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkPoliciesNetworkPolicy.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": "/createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkPolicyId", "type": "string", "info": "UUID representing unique key to this instance", "required": true, "schema": { "title": "networkPolicyId", "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": "/deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship" }, "task": true }, { "name": "getNetworkNetworkPoliciesNetworkPolicy", "summary": "returns network-policy", "description": "returns network-policy", "input": [ { "name": "networkPolicyId", "type": "string", "info": "UUID representing unique key to this instance", "required": true, "schema": { "title": "networkPolicyId", "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": "/getNetworkNetworkPoliciesNetworkPolicy" }, "task": true }, { "name": "createOrUpdateNetworkNetworkPoliciesNetworkPolicy", "summary": "create or update an existing network-policy", "description": "Create or update an existing network-policy.\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": "networkPolicyId", "type": "string", "info": "UUID representing unique key to this instance", "required": true, "schema": { "title": "networkPolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": "network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkPoliciesNetworkPolicy.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": "/createOrUpdateNetworkNetworkPoliciesNetworkPolicy" }, "task": true }, { "name": "updateNetworkNetworkPoliciesNetworkPolicy", "summary": "update an existing network-policy", "description": "Update an existing network-policy\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 requ...(description truncated)", "input": [ { "name": "networkPolicyId", "type": "string", "info": "UUID representing unique key to this instance", "required": true, "schema": { "title": "networkPolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": "network-policy 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": "/updateNetworkNetworkPoliciesNetworkPolicy" }, "task": true }, { "name": "deleteNetworkNetworkPoliciesNetworkPolicy", "summary": "delete an existing network-policy", "description": "delete an existing network-policy", "input": [ { "name": "networkPolicyId", "type": "string", "info": "UUID representing unique key to this instance", "required": true, "schema": { "title": "networkPolicyId", "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": "/deleteNetworkNetworkPoliciesNetworkPolicy" }, "task": true }, { "name": "getNetworkNetworkPolicies", "summary": "returns network-policies", "description": "returns network-policies", "input": [ { "name": "networkPolicyId", "type": "string", "info": "", "required": false, "schema": { "title": "networkPolicyId", "type": "string" } }, { "name": "networkPolicyFqdn", "type": "string", "info": "", "required": false, "schema": { "title": "networkPolicyFqdn", "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": "/getNetworkNetworkPolicies" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnf.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": "/createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "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": "/deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceV...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceV...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInt...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceV...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInt...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceS...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriov...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterface....(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInt...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInt...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/getNetworkGenericVnfsGenericVnfLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterface.j...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateNetworkGenericVnfsGenericVnfLInterfacesLInterface" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getNetworkGenericVnfsGenericVnfLInterfaces" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterf...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterf...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterf...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagI...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterf...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagI...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInte...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterf...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceL...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterf...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterf...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagI...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterf...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagI...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfa...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNameQuery", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceNameQuery", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface", "summary": "returns lag-interface", "description": "returns lag-interface", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface", "summary": "create or update an existing lag-interface", "description": "Create or update an existing lag-interface.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInter...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface", "summary": "update an existing lag-interface", "description": "Update an existing lag-interface\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 requi...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-interface 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": "/updateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface", "summary": "delete an existing lag-interface", "description": "delete an existing lag-interface", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLagInterfaces", "summary": "returns lag-interfaces", "description": "returns lag-interfaces", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "interfaceRole", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceRole", "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": "/getNetworkGenericVnfsGenericVnfLagInterfaces" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vfModuleId", "type": "string", "info": "Unique ID of vf-module.", "required": true, "schema": { "title": "vfModuleId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfVfModulesVfModule.json...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vfModuleId", "type": "string", "info": "Unique ID of vf-module.", "required": true, "schema": { "title": "vfModuleId", "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": "/deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfVfModulesVfModule", "summary": "returns vf-module", "description": "returns vf-module", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vfModuleId", "type": "string", "info": "Unique ID of vf-module.", "required": true, "schema": { "title": "vfModuleId", "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": "/getNetworkGenericVnfsGenericVnfVfModulesVfModule" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule", "summary": "create or update an existing vf-module", "description": "Create or update an existing vf-module.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vfModuleId", "type": "string", "info": "Unique ID of vf-module.", "required": true, "schema": { "title": "vfModuleId", "type": "string" } }, { "name": "body", "type": "object", "info": "vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfVfModulesVfModule.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": "/createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfVfModulesVfModule", "summary": "update an existing vf-module", "description": "Update an existing vf-module\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vfModuleId", "type": "string", "info": "Unique ID of vf-module.", "required": true, "schema": { "title": "vfModuleId", "type": "string" } }, { "name": "body", "type": "object", "info": "vf-module 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": "/updateNetworkGenericVnfsGenericVnfVfModulesVfModule" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfVfModulesVfModule", "summary": "delete an existing vf-module", "description": "delete an existing vf-module", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vfModuleId", "type": "string", "info": "Unique ID of vf-module.", "required": true, "schema": { "title": "vfModuleId", "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": "/deleteNetworkGenericVnfsGenericVnfVfModulesVfModule" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfVfModules", "summary": "returns vf-modules", "description": "returns vf-modules", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vfModuleId", "type": "string", "info": "", "required": false, "schema": { "title": "vfModuleId", "type": "string" } }, { "name": "vfModuleName", "type": "string", "info": "", "required": false, "schema": { "title": "vfModuleName", "type": "string" } }, { "name": "heatStackId", "type": "string", "info": "", "required": false, "schema": { "title": "heatStackId", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "widgetModelId", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelId", "type": "string" } }, { "name": "widgetModelVersion", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelVersion", "type": "string" } }, { "name": "contrailServiceInstanceFqdn", "type": "string", "info": "", "required": false, "schema": { "title": "contrailServiceInstanceFqdn", "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": "/getNetworkGenericVnfsGenericVnfVfModules" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLicensesLicense.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": "/createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLicensesLicense", "summary": "returns license", "description": "returns license", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/getNetworkGenericVnfsGenericVnfLicensesLicense" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense", "summary": "create or update an existing license", "description": "Create or update an existing license.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLicensesLicense.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": "/createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfLicensesLicense", "summary": "update an existing license", "description": "Update an existing license\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "license 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": "/updateNetworkGenericVnfsGenericVnfLicensesLicense" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfLicensesLicense", "summary": "delete an existing license", "description": "delete an existing license", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the license group the resource belongs to, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of a license resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/deleteNetworkGenericVnfsGenericVnfLicensesLicense" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfLicenses", "summary": "returns licenses", "description": "returns licenses", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "", "required": false, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "", "required": false, "schema": { "title": "resourceUuid", "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": "/getNetworkGenericVnfsGenericVnfLicenses" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfEntitlementsEntitlemen...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfEntitlementsEntitlement", "summary": "returns entitlement", "description": "returns entitlement", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/getNetworkGenericVnfsGenericVnfEntitlementsEntitlement" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement", "summary": "create or update an existing entitlement", "description": "Create or update an existing entitlement.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfEntitlementsEntitlement...(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": "/createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnfEntitlementsEntitlement", "summary": "update an existing entitlement", "description": "Update an existing entitlement\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 require...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "entitlement 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": "/updateNetworkGenericVnfsGenericVnfEntitlementsEntitlement" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement", "summary": "delete an existing entitlement", "description": "delete an existing entitlement", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "Unique ID for the entitlement group the resource comes from, should be uuid.", "required": true, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "Unique ID of an entitlement resource.", "required": true, "schema": { "title": "resourceUuid", "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": "/deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnfEntitlements", "summary": "returns entitlements", "description": "returns entitlements", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "groupUuid", "type": "string", "info": "", "required": false, "schema": { "title": "groupUuid", "type": "string" } }, { "name": "resourceUuid", "type": "string", "info": "", "required": false, "schema": { "title": "resourceUuid", "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": "/getNetworkGenericVnfsGenericVnfEntitlements" }, "task": true }, { "name": "getNetworkGenericVnfsGenericVnf", "summary": "returns generic-vnf", "description": "returns generic-vnf", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "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": "/getNetworkGenericVnfsGenericVnf" }, "task": true }, { "name": "createOrUpdateNetworkGenericVnfsGenericVnf", "summary": "create or update an existing generic-vnf", "description": "Create or update an existing generic-vnf.\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": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "body", "type": "object", "info": "generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnf.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": "/createOrUpdateNetworkGenericVnfsGenericVnf" }, "task": true }, { "name": "updateNetworkGenericVnfsGenericVnf", "summary": "update an existing generic-vnf", "description": "Update an existing generic-vnf\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 require...(description truncated)", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "type": "string" } }, { "name": "body", "type": "object", "info": "generic-vnf 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": "/updateNetworkGenericVnfsGenericVnf" }, "task": true }, { "name": "deleteNetworkGenericVnfsGenericVnf", "summary": "delete an existing generic-vnf", "description": "delete an existing generic-vnf", "input": [ { "name": "vnfId", "type": "string", "info": "Unique id of VNF. This is unique across the graph.", "required": true, "schema": { "title": "vnfId", "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": "/deleteNetworkGenericVnfsGenericVnf" }, "task": true }, { "name": "getNetworkGenericVnfs", "summary": "returns generic-vnfs", "description": "returns generic-vnfs", "input": [ { "name": "vnfId", "type": "string", "info": "", "required": false, "schema": { "title": "vnfId", "type": "string" } }, { "name": "vnfName", "type": "string", "info": "", "required": false, "schema": { "title": "vnfName", "type": "string" } }, { "name": "vnfName2", "type": "string", "info": "", "required": false, "schema": { "title": "vnfName2", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "", "required": false, "schema": { "title": "vnfType", "type": "string" } }, { "name": "serviceId", "type": "string", "info": "", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "regionalResourceZone", "type": "string", "info": "", "required": false, "schema": { "title": "regionalResourceZone", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "heatStackId", "type": "string", "info": "", "required": false, "schema": { "title": "heatStackId", "type": "string" } }, { "name": "inMaint", "type": "boolean", "info": "", "required": false, "schema": { "title": "inMaint", "type": "boolean" } }, { "name": "isClosedLoopDisabled", "type": "boolean", "info": "", "required": false, "schema": { "title": "isClosedLoopDisabled", "type": "boolean" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "type": "string" } }, { "name": "widgetModelId", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelId", "type": "string" } }, { "name": "widgetModelVersion", "type": "string", "info": "", "required": false, "schema": { "title": "widgetModelVersion", "type": "string" } }, { "name": "nfType", "type": "string", "info": "", "required": false, "schema": { "title": "nfType", "type": "string" } }, { "name": "nfFunction", "type": "string", "info": "", "required": false, "schema": { "title": "nfFunction", "type": "string" } }, { "name": "nfRole", "type": "string", "info": "", "required": false, "schema": { "title": "nfRole", "type": "string" } }, { "name": "nfNamingCode", "type": "string", "info": "", "required": false, "schema": { "title": "nfNamingCode", "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": "/getNetworkGenericVnfs" }, "task": true }, { "name": "createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "linkName", "type": "string", "info": "Alphabetical concatenation of lag-interface names", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLagLinksLagLink.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": "/createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkLagLinksLagLinkRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "linkName", "type": "string", "info": "Alphabetical concatenation of lag-interface names", "required": true, "schema": { "title": "linkName", "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": "/deleteNetworkLagLinksLagLinkRelationshipListRelationship" }, "task": true }, { "name": "getNetworkLagLinksLagLink", "summary": "returns lag-link", "description": "returns lag-link", "input": [ { "name": "linkName", "type": "string", "info": "Alphabetical concatenation of lag-interface names", "required": true, "schema": { "title": "linkName", "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": "/getNetworkLagLinksLagLink" }, "task": true }, { "name": "createOrUpdateNetworkLagLinksLagLink", "summary": "create or update an existing lag-link", "description": "Create or update an existing lag-link.\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": "linkName", "type": "string", "info": "Alphabetical concatenation of lag-interface names", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLagLinksLagLink.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": "/createOrUpdateNetworkLagLinksLagLink" }, "task": true }, { "name": "updateNetworkLagLinksLagLink", "summary": "update an existing lag-link", "description": "Update an existing lag-link\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 v...(description truncated)", "input": [ { "name": "linkName", "type": "string", "info": "Alphabetical concatenation of lag-interface names", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-link 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": "/updateNetworkLagLinksLagLink" }, "task": true }, { "name": "deleteNetworkLagLinksLagLink", "summary": "delete an existing lag-link", "description": "delete an existing lag-link", "input": [ { "name": "linkName", "type": "string", "info": "Alphabetical concatenation of lag-interface names", "required": true, "schema": { "title": "linkName", "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": "/deleteNetworkLagLinksLagLink" }, "task": true }, { "name": "getNetworkLagLinks", "summary": "returns lag-links", "description": "returns lag-links", "input": [ { "name": "linkName", "type": "string", "info": "", "required": false, "schema": { "title": "linkName", "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": "/getNetworkLagLinks" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvce.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": "/createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "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": "/deleteNetworkNewvcesNewvceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesL...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesL...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getNetworkNewvcesNewvceLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsS...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriov...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterface.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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3Interfa...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesL...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3Interfa...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesL...(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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/getNetworkNewvcesNewvceLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterface.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": "/createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface" }, "task": true }, { "name": "updateNetworkNewvcesNewvceLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateNetworkNewvcesNewvceLInterfacesLInterface" }, "task": true }, { "name": "deleteNetworkNewvcesNewvceLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkNewvcesNewvceLInterfacesLInterface" }, "task": true }, { "name": "getNetworkNewvcesNewvceLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getNetworkNewvcesNewvceLInterfaces" }, "task": true }, { "name": "getNetworkNewvcesNewvce", "summary": "returns newvce", "description": "returns newvce", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "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": "/getNetworkNewvcesNewvce" }, "task": true }, { "name": "createOrUpdateNetworkNewvcesNewvce", "summary": "create or update an existing newvce", "description": "Create or update an existing newvce.\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": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "body", "type": "object", "info": "newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvce.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": "/createOrUpdateNetworkNewvcesNewvce" }, "task": true }, { "name": "updateNetworkNewvcesNewvce", "summary": "update an existing newvce", "description": "Update an existing newvce\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 val...(description truncated)", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "body", "type": "object", "info": "newvce 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": "/updateNetworkNewvcesNewvce" }, "task": true }, { "name": "deleteNetworkNewvcesNewvce", "summary": "delete an existing newvce", "description": "delete an existing newvce", "input": [ { "name": "vnfId2", "type": "string", "info": "Unique id of VNF, can't use same attribute name right now until we promote this new object", "required": true, "schema": { "title": "vnfId2", "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": "/deleteNetworkNewvcesNewvce" }, "task": true }, { "name": "getNetworkNewvces", "summary": "returns newvces", "description": "returns newvces", "input": [ { "name": "vnfId2", "type": "string", "info": "", "required": false, "schema": { "title": "vnfId2", "type": "string" } }, { "name": "vnfName", "type": "string", "info": "", "required": false, "schema": { "title": "vnfName", "type": "string" } }, { "name": "vnfName2", "type": "string", "info": "", "required": false, "schema": { "title": "vnfName2", "type": "string" } }, { "name": "vnfType", "type": "string", "info": "", "required": false, "schema": { "title": "vnfType", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "heatStackId", "type": "string", "info": "", "required": false, "schema": { "title": "heatStackId", "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": "/getNetworkNewvces" }, "task": true }, { "name": "getNetworkPnfsPnfSoftwareVersionsSoftwareVersion", "summary": "returns software-version", "description": "returns software-version", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "softwareVersionId", "type": "string", "info": "Identifier of the software version", "required": true, "schema": { "title": "softwareVersionId", "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": "/getNetworkPnfsPnfSoftwareVersionsSoftwareVersion" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfSoftwareVersionsSoftwareVersion", "summary": "create or update an existing software-version", "description": "Create or update an existing software-version.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "softwareVersionId", "type": "string", "info": "Identifier of the software version", "required": true, "schema": { "title": "softwareVersionId", "type": "string" } }, { "name": "body", "type": "object", "info": "software-version object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfSoftwareVersionsSoftwareVersion....(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": "/createOrUpdateNetworkPnfsPnfSoftwareVersionsSoftwareVersion" }, "task": true }, { "name": "updateNetworkPnfsPnfSoftwareVersionsSoftwareVersion", "summary": "update an existing software-version", "description": "Update an existing software-version\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 re...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "softwareVersionId", "type": "string", "info": "Identifier of the software version", "required": true, "schema": { "title": "softwareVersionId", "type": "string" } }, { "name": "body", "type": "object", "info": "software-version 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": "/updateNetworkPnfsPnfSoftwareVersionsSoftwareVersion" }, "task": true }, { "name": "deleteNetworkPnfsPnfSoftwareVersionsSoftwareVersion", "summary": "delete an existing software-version", "description": "delete an existing software-version", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "softwareVersionId", "type": "string", "info": "Identifier of the software version", "required": true, "schema": { "title": "softwareVersionId", "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": "/deleteNetworkPnfsPnfSoftwareVersionsSoftwareVersion" }, "task": true }, { "name": "getNetworkPnfsPnfSoftwareVersions", "summary": "returns software-versions", "description": "returns software-versions", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "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": "/getNetworkPnfsPnfSoftwareVersions" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnf.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": "/createOrUpdateNetworkPnfsPnfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "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": "/deleteNetworkPnfsPnfRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterface.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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf", "summary": "returns sriov-pf", "description": "returns sriov-pf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf", "summary": "create or update an existing sriov-pf", "description": "Create or update an existing sriov-pf.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.jso...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf", "summary": "update an existing sriov-pf", "description": "Update an existing sriov-pf\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 v...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-pf 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": "/updateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf", "summary": "delete an existing sriov-pf", "description": "delete an existing sriov-pf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "Identifier for the sriov-pf", "required": true, "schema": { "title": "pfPciId", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs", "summary": "returns sriov-pfs", "description": "returns sriov-pfs", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "pfPciId", "type": "string", "info": "", "required": false, "schema": { "title": "pfPciId", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInt...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInt...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterf...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInt...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterf...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVl...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInt...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfa...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInt...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInt...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterf...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInt...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterf...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInte...(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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNameQuery", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceNameQuery", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfacesPInterface", "summary": "returns p-interface", "description": "returns p-interface", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/getNetworkPnfsPnfPInterfacesPInterface" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfPInterfacesPInterface", "summary": "create or update an existing p-interface", "description": "Create or update an existing p-interface.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterface.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": "/createOrUpdateNetworkPnfsPnfPInterfacesPInterface" }, "task": true }, { "name": "updateNetworkPnfsPnfPInterfacesPInterface", "summary": "update an existing p-interface", "description": "Update an existing p-interface\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 require...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "p-interface 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": "/updateNetworkPnfsPnfPInterfacesPInterface" }, "task": true }, { "name": "deleteNetworkPnfsPnfPInterfacesPInterface", "summary": "delete an existing p-interface", "description": "delete an existing p-interface", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the physical interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkPnfsPnfPInterfacesPInterface" }, "task": true }, { "name": "getNetworkPnfsPnfPInterfaces", "summary": "returns p-interfaces", "description": "returns p-interfaces", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "provStatus", "type": "string", "info": "", "required": false, "schema": { "title": "provStatus", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "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": "/getNetworkPnfsPnfPInterfaces" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterface.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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagIn...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagIn...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "returns vlan", "description": "returns vlan", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "create or update an existing vlan", "description": "Create or update an existing vlan.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfa...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "update an existing vlan", "description": "Update an existing vlan\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 value...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan 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": "/updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan", "summary": "delete an existing vlan", "description": "delete an existing vlan", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "String that identifies the interface", "required": true, "schema": { "title": "vlanInterface", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans", "summary": "returns vlans", "description": "returns vlans", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "vlanInterface", "type": "string", "info": "", "required": false, "schema": { "title": "vlanInterface", "type": "string" } }, { "name": "vlanIdInner", "type": "number", "info": "", "required": false, "schema": { "title": "vlanIdInner", "type": "number" } }, { "name": "vpnKey", "type": "string", "info": "", "required": false, "schema": { "title": "vpnKey", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "returns sriov-vf", "description": "returns sriov-vf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "create or update an existing sriov-vf", "description": "Create or update an existing sriov-vf.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInt...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "update an existing sriov-vf", "description": "Update an existing sriov-vf\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 v...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "type": "string" } }, { "name": "body", "type": "object", "info": "sriov-vf 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": "/updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf", "summary": "delete an existing sriov-vf", "description": "delete an existing sriov-vf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "PCI ID used to identify the sriov-vf", "required": true, "schema": { "title": "pciId", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs", "summary": "returns sriov-vfs", "description": "returns sriov-vfs", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "pciId", "type": "string", "info": "", "required": false, "schema": { "title": "pciId", "type": "string" } }, { "name": "vfVlanFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfVlanFilter", "type": "string" } }, { "name": "vfMacFilter", "type": "string", "info": "", "required": false, "schema": { "title": "vfMacFilter", "type": "string" } }, { "name": "vfVlanStrip", "type": "boolean", "info": "", "required": false, "schema": { "title": "vfVlanStrip", "type": "boolean" } }, { "name": "neutronNetworkId", "type": "string", "info": "", "required": false, "schema": { "title": "neutronNetworkId", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "returns l3-interface-ipv4-address-list", "description": "returns l3-interface-ipv4-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "create or update an existing l3-interface-ipv4-address-list", "description": "Create or update an existing l3-interface-ipv4-address-list.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagIn...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "update an existing l3-interface-ipv4-address-list", "description": "Update an existing l3-interface-ipv4-address-list\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. T...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv4-address-list 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": "/updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList", "summary": "delete an existing l3-interface-ipv4-address-list", "description": "delete an existing l3-interface-ipv4-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv4Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv4Address", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "returns l3-interface-ipv6-address-list", "description": "returns l3-interface-ipv6-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "create or update an existing l3-interface-ipv6-address-list", "description": "Create or update an existing l3-interface-ipv6-address-list.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagIn...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "update an existing l3-interface-ipv6-address-list", "description": "Update an existing l3-interface-ipv6-address-list\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. T...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "type": "string" } }, { "name": "body", "type": "object", "info": "l3-interface-ipv6-address-list 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": "/updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList", "summary": "delete an existing l3-interface-ipv6-address-list", "description": "delete an existing l3-interface-ipv6-address-list", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "l3InterfaceIpv6Address", "type": "string", "info": "IP address", "required": true, "schema": { "title": "l3InterfaceIpv6Address", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "returns l-interface", "description": "returns l-interface", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "create or update an existing l-interface", "description": "Create or update an existing l-interface.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesL...(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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "update an existing l-interface", "description": "Update an existing l-interface\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 require...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "type": "string" } }, { "name": "body", "type": "object", "info": "l-interface 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": "/updateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface", "summary": "delete an existing l-interface", "description": "delete an existing l-interface", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNamePath", "type": "string", "info": "Name given to the interface", "required": true, "schema": { "title": "interfaceNamePath", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces", "summary": "returns l-interfaces", "description": "returns l-interfaces", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceNameQuery", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceNameQuery", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "macaddr", "type": "string", "info": "", "required": false, "schema": { "title": "macaddr", "type": "string" } }, { "name": "networkName", "type": "string", "info": "", "required": false, "schema": { "title": "networkName", "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": "/getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfacesLagInterface", "summary": "returns lag-interface", "description": "returns lag-interface", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/getNetworkPnfsPnfLagInterfacesLagInterface" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface", "summary": "create or update an existing lag-interface", "description": "Create or update an existing lag-interface.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterface.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": "/createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface" }, "task": true }, { "name": "updateNetworkPnfsPnfLagInterfacesLagInterface", "summary": "update an existing lag-interface", "description": "Update an existing lag-interface\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 requi...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "body", "type": "object", "info": "lag-interface 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": "/updateNetworkPnfsPnfLagInterfacesLagInterface" }, "task": true }, { "name": "deleteNetworkPnfsPnfLagInterfacesLagInterface", "summary": "delete an existing lag-interface", "description": "delete an existing lag-interface", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "Name that identifies the link aggregate interface", "required": true, "schema": { "title": "interfaceName", "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": "/deleteNetworkPnfsPnfLagInterfacesLagInterface" }, "task": true }, { "name": "getNetworkPnfsPnfLagInterfaces", "summary": "returns lag-interfaces", "description": "returns lag-interfaces", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "interfaceName", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceName", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "interfaceRole", "type": "string", "info": "", "required": false, "schema": { "title": "interfaceRole", "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": "/getNetworkPnfsPnfLagInterfaces" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTargetRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget.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": "/createOrUpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTargetRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfVrfsVrfRouteTargetsRouteTargetRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "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": "/deleteNetworkPnfsPnfVrfsVrfRouteTargetsRouteTargetRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget", "summary": "returns route-target", "description": "returns route-target", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "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": "/getNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget", "summary": "create or update an existing route-target", "description": "Create or update an existing route-target.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "type": "string" } }, { "name": "body", "type": "object", "info": "route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget.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": "/createOrUpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget" }, "task": true }, { "name": "updateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget", "summary": "update an existing route-target", "description": "Update an existing route-target\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 requir...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "type": "string" } }, { "name": "body", "type": "object", "info": "route-target 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": "/updateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget" }, "task": true }, { "name": "deleteNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget", "summary": "delete an existing route-target", "description": "delete an existing route-target", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "globalRouteTarget", "type": "string", "info": "Number used to identify an RT, globally unique in the network", "required": true, "schema": { "title": "globalRouteTarget", "type": "string" } }, { "name": "routeTargetRole", "type": "string", "info": "Role assigned to this route target", "required": true, "schema": { "title": "routeTargetRole", "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": "/deleteNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget" }, "task": true }, { "name": "getNetworkPnfsPnfVrfsVrfRouteTargets", "summary": "returns route-targets", "description": "returns route-targets", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "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": "/getNetworkPnfsPnfVrfsVrfRouteTargets" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfVrfsVrfRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrf.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": "/createOrUpdateNetworkPnfsPnfVrfsVrfRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPnfsPnfVrfsVrfRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "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": "/deleteNetworkPnfsPnfVrfsVrfRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPnfsPnfVrfsVrf", "summary": "returns vrf", "description": "returns vrf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "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": "/getNetworkPnfsPnfVrfsVrf" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnfVrfsVrf", "summary": "create or update an existing vrf", "description": "Create or update an existing vrf.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "body", "type": "object", "info": "vrf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrf.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": "/createOrUpdateNetworkPnfsPnfVrfsVrf" }, "task": true }, { "name": "updateNetworkPnfsPnfVrfsVrf", "summary": "update an existing vrf", "description": "Update an existing vrf\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 values...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "type": "string" } }, { "name": "body", "type": "object", "info": "vrf 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": "/updateNetworkPnfsPnfVrfsVrf" }, "task": true }, { "name": "deleteNetworkPnfsPnfVrfsVrf", "summary": "delete an existing vrf", "description": "delete an existing vrf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "VRF UUID.", "required": true, "schema": { "title": "vrfId", "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": "/deleteNetworkPnfsPnfVrfsVrf" }, "task": true }, { "name": "getNetworkPnfsPnfVrfs", "summary": "returns vrfs", "description": "returns vrfs", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "vrfId", "type": "string", "info": "", "required": false, "schema": { "title": "vrfId", "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": "/getNetworkPnfsPnfVrfs" }, "task": true }, { "name": "getNetworkPnfsPnf", "summary": "returns pnf", "description": "returns pnf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "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": "/getNetworkPnfsPnf" }, "task": true }, { "name": "createOrUpdateNetworkPnfsPnf", "summary": "create or update an existing pnf", "description": "Create or update an existing pnf.\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": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "body", "type": "object", "info": "pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnf.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": "/createOrUpdateNetworkPnfsPnf" }, "task": true }, { "name": "updateNetworkPnfsPnf", "summary": "update an existing pnf", "description": "Update an existing pnf\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 values...(description truncated)", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "type": "string" } }, { "name": "body", "type": "object", "info": "pnf 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": "/updateNetworkPnfsPnf" }, "task": true }, { "name": "deleteNetworkPnfsPnf", "summary": "delete an existing pnf", "description": "delete an existing pnf", "input": [ { "name": "pnfName", "type": "string", "info": "unique name of Physical Network Function.", "required": true, "schema": { "title": "pnfName", "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": "/deleteNetworkPnfsPnf" }, "task": true }, { "name": "getNetworkPnfs", "summary": "returns pnfs", "description": "returns pnfs", "input": [ { "name": "pnfName", "type": "string", "info": "", "required": false, "schema": { "title": "pnfName", "type": "string" } }, { "name": "orchestrationStatus", "type": "string", "info": "", "required": false, "schema": { "title": "orchestrationStatus", "type": "string" } }, { "name": "invStatus", "type": "string", "info": "", "required": false, "schema": { "title": "invStatus", "type": "string" } }, { "name": "adminStatus", "type": "string", "info": "", "required": false, "schema": { "title": "adminStatus", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkPnfs" }, "task": true }, { "name": "createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "linkName", "type": "string", "info": "e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPhysicalLinksPhysicalLink.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": "/createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "linkName", "type": "string", "info": "e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ", "required": true, "schema": { "title": "linkName", "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": "/deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship" }, "task": true }, { "name": "getNetworkPhysicalLinksPhysicalLink", "summary": "returns physical-link", "description": "returns physical-link", "input": [ { "name": "linkName", "type": "string", "info": "e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ", "required": true, "schema": { "title": "linkName", "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": "/getNetworkPhysicalLinksPhysicalLink" }, "task": true }, { "name": "createOrUpdateNetworkPhysicalLinksPhysicalLink", "summary": "create or update an existing physical-link", "description": "Create or update an existing physical-link.\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": "linkName", "type": "string", "info": "e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPhysicalLinksPhysicalLink.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": "/createOrUpdateNetworkPhysicalLinksPhysicalLink" }, "task": true }, { "name": "updateNetworkPhysicalLinksPhysicalLink", "summary": "update an existing physical-link", "description": "Update an existing physical-link\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 requi...(description truncated)", "input": [ { "name": "linkName", "type": "string", "info": "e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ", "required": true, "schema": { "title": "linkName", "type": "string" } }, { "name": "body", "type": "object", "info": "physical-link 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": "/updateNetworkPhysicalLinksPhysicalLink" }, "task": true }, { "name": "deleteNetworkPhysicalLinksPhysicalLink", "summary": "delete an existing physical-link", "description": "delete an existing physical-link", "input": [ { "name": "linkName", "type": "string", "info": "e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ", "required": true, "schema": { "title": "linkName", "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": "/deleteNetworkPhysicalLinksPhysicalLink" }, "task": true }, { "name": "getNetworkPhysicalLinks", "summary": "returns physical-links", "description": "returns physical-links", "input": [ { "name": "linkName", "type": "string", "info": "", "required": false, "schema": { "title": "linkName", "type": "string" } }, { "name": "circuitId", "type": "string", "info": "", "required": false, "schema": { "title": "circuitId", "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": "/getNetworkPhysicalLinks" }, "task": true }, { "name": "createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfiguration.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": "/createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "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": "/deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "vigAddressType", "type": "string", "info": "indicates whether the VIG is for AVPN or INTERNET", "required": true, "schema": { "title": "vigAddressType", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfigurationVigSer...(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": "/createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "vigAddressType", "type": "string", "info": "indicates whether the VIG is for AVPN or INTERNET", "required": true, "schema": { "title": "vigAddressType", "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": "/deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship" }, "task": true }, { "name": "getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer", "summary": "returns vig-server", "description": "returns vig-server", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "vigAddressType", "type": "string", "info": "indicates whether the VIG is for AVPN or INTERNET", "required": true, "schema": { "title": "vigAddressType", "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": "/getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer" }, "task": true }, { "name": "createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer", "summary": "create or update an existing vig-server", "description": "Create or update an existing vig-server.\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": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "vigAddressType", "type": "string", "info": "indicates whether the VIG is for AVPN or INTERNET", "required": true, "schema": { "title": "vigAddressType", "type": "string" } }, { "name": "body", "type": "object", "info": "vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfigurationVigServe...(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": "/createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer" }, "task": true }, { "name": "updateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer", "summary": "update an existing vig-server", "description": "Update an existing vig-server\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": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "vigAddressType", "type": "string", "info": "indicates whether the VIG is for AVPN or INTERNET", "required": true, "schema": { "title": "vigAddressType", "type": "string" } }, { "name": "body", "type": "object", "info": "vig-server 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": "/updateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer" }, "task": true }, { "name": "deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer", "summary": "delete an existing vig-server", "description": "delete an existing vig-server", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "vigAddressType", "type": "string", "info": "indicates whether the VIG is for AVPN or INTERNET", "required": true, "schema": { "title": "vigAddressType", "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": "/deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer" }, "task": true }, { "name": "getNetworkIpsecConfigurationsIpsecConfigurationVigServers", "summary": "returns vig-servers", "description": "returns vig-servers", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "vigAddressType", "type": "string", "info": "", "required": false, "schema": { "title": "vigAddressType", "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": "/getNetworkIpsecConfigurationsIpsecConfigurationVigServers" }, "task": true }, { "name": "getNetworkIpsecConfigurationsIpsecConfiguration", "summary": "returns ipsec-configuration", "description": "returns ipsec-configuration", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "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": "/getNetworkIpsecConfigurationsIpsecConfiguration" }, "task": true }, { "name": "createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration", "summary": "create or update an existing ipsec-configuration", "description": "Create or update an existing ipsec-configuration.\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": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfiguratio...(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": "/createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration" }, "task": true }, { "name": "updateNetworkIpsecConfigurationsIpsecConfiguration", "summary": "update an existing ipsec-configuration", "description": "Update an existing ipsec-configuration\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...(description truncated)", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "ipsec-configuration 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": "/updateNetworkIpsecConfigurationsIpsecConfiguration" }, "task": true }, { "name": "deleteNetworkIpsecConfigurationsIpsecConfiguration", "summary": "delete an existing ipsec-configuration", "description": "delete an existing ipsec-configuration", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "UUID of this configuration", "required": true, "schema": { "title": "ipsecConfigurationId", "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": "/deleteNetworkIpsecConfigurationsIpsecConfiguration" }, "task": true }, { "name": "getNetworkIpsecConfigurations", "summary": "returns ipsec-configurations", "description": "returns ipsec-configurations", "input": [ { "name": "ipsecConfigurationId", "type": "string", "info": "", "required": false, "schema": { "title": "ipsecConfigurationId", "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": "/getNetworkIpsecConfigurations" }, "task": true }, { "name": "createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "routeTableReferenceId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "routeTableReferenceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkRouteTableReferencesRouteTableReference.jso...(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": "/createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "routeTableReferenceId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "routeTableReferenceId", "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": "/deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship" }, "task": true }, { "name": "getNetworkRouteTableReferencesRouteTableReference", "summary": "returns route-table-reference", "description": "returns route-table-reference", "input": [ { "name": "routeTableReferenceId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "routeTableReferenceId", "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": "/getNetworkRouteTableReferencesRouteTableReference" }, "task": true }, { "name": "createOrUpdateNetworkRouteTableReferencesRouteTableReference", "summary": "create or update an existing route-table-reference", "description": "Create or update an existing route-table-reference.\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": "routeTableReferenceId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "routeTableReferenceId", "type": "string" } }, { "name": "body", "type": "object", "info": "route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkRouteTableReferencesRouteTableRefe...(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": "/createOrUpdateNetworkRouteTableReferencesRouteTableReference" }, "task": true }, { "name": "updateNetworkRouteTableReferencesRouteTableReference", "summary": "update an existing route-table-reference", "description": "Update an existing route-table-reference\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 ...(description truncated)", "input": [ { "name": "routeTableReferenceId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "routeTableReferenceId", "type": "string" } }, { "name": "body", "type": "object", "info": "route-table-reference 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": "/updateNetworkRouteTableReferencesRouteTableReference" }, "task": true }, { "name": "deleteNetworkRouteTableReferencesRouteTableReference", "summary": "delete an existing route-table-reference", "description": "delete an existing route-table-reference", "input": [ { "name": "routeTableReferenceId", "type": "string", "info": "Route Table Reference id, UUID assigned to this instance.", "required": true, "schema": { "title": "routeTableReferenceId", "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": "/deleteNetworkRouteTableReferencesRouteTableReference" }, "task": true }, { "name": "getNetworkRouteTableReferences", "summary": "returns route-table-references", "description": "returns route-table-references", "input": [ { "name": "routeTableReferenceId", "type": "string", "info": "", "required": false, "schema": { "title": "routeTableReferenceId", "type": "string" } }, { "name": "routeTableReferenceFqdn", "type": "string", "info": "", "required": false, "schema": { "title": "routeTableReferenceFqdn", "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": "/getNetworkRouteTableReferences" }, "task": true }, { "name": "createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "id", "type": "string", "info": "Instance Group ID, UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkInstanceGroupsInstanceGroup.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": "/createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "id", "type": "string", "info": "Instance Group ID, UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship" }, "task": true }, { "name": "getNetworkInstanceGroupsInstanceGroup", "summary": "returns instance-group", "description": "returns instance-group", "input": [ { "name": "id", "type": "string", "info": "Instance Group ID, UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworkInstanceGroupsInstanceGroup" }, "task": true }, { "name": "createOrUpdateNetworkInstanceGroupsInstanceGroup", "summary": "create or update an existing instance-group", "description": "Create or update an existing instance-group.\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": "id", "type": "string", "info": "Instance Group ID, UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkInstanceGroupsInstanceGroup.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": "/createOrUpdateNetworkInstanceGroupsInstanceGroup" }, "task": true }, { "name": "updateNetworkInstanceGroupsInstanceGroup", "summary": "update an existing instance-group", "description": "Update an existing instance-group\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 requ...(description truncated)", "input": [ { "name": "id", "type": "string", "info": "Instance Group ID, UUID assigned to this instance.", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "instance-group 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": "/updateNetworkInstanceGroupsInstanceGroup" }, "task": true }, { "name": "deleteNetworkInstanceGroupsInstanceGroup", "summary": "delete an existing instance-group", "description": "delete an existing instance-group", "input": [ { "name": "id", "type": "string", "info": "Instance Group ID, UUID assigned to this instance.", "required": true, "schema": { "title": "id", "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": "/deleteNetworkInstanceGroupsInstanceGroup" }, "task": true }, { "name": "getNetworkInstanceGroups", "summary": "returns instance-groups", "description": "returns instance-groups", "input": [ { "name": "id", "type": "string", "info": "", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkInstanceGroups" }, "task": true }, { "name": "createOrUpdateNetworkZonesZoneRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "zoneId", "type": "string", "info": "Code assigned by AIC to the zone", "required": true, "schema": { "title": "zoneId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkZonesZone.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": "/createOrUpdateNetworkZonesZoneRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkZonesZoneRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "zoneId", "type": "string", "info": "Code assigned by AIC to the zone", "required": true, "schema": { "title": "zoneId", "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": "/deleteNetworkZonesZoneRelationshipListRelationship" }, "task": true }, { "name": "getNetworkZonesZone", "summary": "returns zone", "description": "returns zone", "input": [ { "name": "zoneId", "type": "string", "info": "Code assigned by AIC to the zone", "required": true, "schema": { "title": "zoneId", "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": "/getNetworkZonesZone" }, "task": true }, { "name": "createOrUpdateNetworkZonesZone", "summary": "create or update an existing zone", "description": "Create or update an existing zone.\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": "zoneId", "type": "string", "info": "Code assigned by AIC to the zone", "required": true, "schema": { "title": "zoneId", "type": "string" } }, { "name": "body", "type": "object", "info": "zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkZonesZone.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": "/createOrUpdateNetworkZonesZone" }, "task": true }, { "name": "updateNetworkZonesZone", "summary": "update an existing zone", "description": "Update an existing zone\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 value...(description truncated)", "input": [ { "name": "zoneId", "type": "string", "info": "Code assigned by AIC to the zone", "required": true, "schema": { "title": "zoneId", "type": "string" } }, { "name": "body", "type": "object", "info": "zone 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": "/updateNetworkZonesZone" }, "task": true }, { "name": "deleteNetworkZonesZone", "summary": "delete an existing zone", "description": "delete an existing zone", "input": [ { "name": "zoneId", "type": "string", "info": "Code assigned by AIC to the zone", "required": true, "schema": { "title": "zoneId", "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": "/deleteNetworkZonesZone" }, "task": true }, { "name": "getNetworkZones", "summary": "returns zones", "description": "returns zones", "input": [ { "name": "zoneId", "type": "string", "info": "", "required": false, "schema": { "title": "zoneId", "type": "string" } }, { "name": "designType", "type": "string", "info": "", "required": false, "schema": { "title": "designType", "type": "string" } }, { "name": "zoneContext", "type": "string", "info": "", "required": false, "schema": { "title": "zoneContext", "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": "/getNetworkZones" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfiguration.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": "/createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkConfigurationsConfigurationRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "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": "/deleteNetworkConfigurationsConfigurationRelationshipListRelationship" }, "task": true }, { "name": "getNetworkConfigurationsConfigurationMetadataMetadatum", "summary": "returns metadatum", "description": "returns metadatum", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/getNetworkConfigurationsConfigurationMetadataMetadatum" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum", "summary": "create or update an existing metadatum", "description": "Create or update an existing metadatum.\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": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationMetadataMetadatum.j...(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": "/createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum" }, "task": true }, { "name": "updateNetworkConfigurationsConfigurationMetadataMetadatum", "summary": "update an existing metadatum", "description": "Update an existing metadatum\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": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "type": "string" } }, { "name": "body", "type": "object", "info": "metadatum 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": "/updateNetworkConfigurationsConfigurationMetadataMetadatum" }, "task": true }, { "name": "deleteNetworkConfigurationsConfigurationMetadataMetadatum", "summary": "delete an existing metadatum", "description": "delete an existing metadatum", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": true, "schema": { "title": "metaname", "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": "/deleteNetworkConfigurationsConfigurationMetadataMetadatum" }, "task": true }, { "name": "getNetworkConfigurationsConfigurationMetadata", "summary": "returns metadata", "description": "returns metadata", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "metaname", "type": "string", "info": "", "required": false, "schema": { "title": "metaname", "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": "/getNetworkConfigurationsConfigurationMetadata" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMappingRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "vlanMappingId", "type": "string", "info": "Key for vlan-mapping object.", "required": true, "schema": { "title": "vlanMappingId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsFor...(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": "/createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMappingRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMappingRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "vlanMappingId", "type": "string", "info": "Key for vlan-mapping object.", "required": true, "schema": { "title": "vlanMappingId", "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": "/deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMappingRelationshipListRelationship" }, "task": true }, { "name": "getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping", "summary": "returns vlan-mapping", "description": "returns vlan-mapping", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "vlanMappingId", "type": "string", "info": "Key for vlan-mapping object.", "required": true, "schema": { "title": "vlanMappingId", "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": "/getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping", "summary": "create or update an existing vlan-mapping", "description": "Create or update an existing vlan-mapping.\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": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "vlanMappingId", "type": "string", "info": "Key for vlan-mapping object.", "required": true, "schema": { "title": "vlanMappingId", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan-mapping object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsFor...(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": "/createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping" }, "task": true }, { "name": "updateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping", "summary": "update an existing vlan-mapping", "description": "Update an existing vlan-mapping\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 requir...(description truncated)", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "vlanMappingId", "type": "string", "info": "Key for vlan-mapping object.", "required": true, "schema": { "title": "vlanMappingId", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan-mapping 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": "/updateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping" }, "task": true }, { "name": "deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping", "summary": "delete an existing vlan-mapping", "description": "delete an existing vlan-mapping", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "vlanMappingId", "type": "string", "info": "Key for vlan-mapping object.", "required": true, "schema": { "title": "vlanMappingId", "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": "/deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping" }, "task": true }, { "name": "getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappings", "summary": "returns vlan-mappings", "description": "returns vlan-mappings", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "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": "/getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappings" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsFor...(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": "/createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "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": "/deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship" }, "task": true }, { "name": "getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc", "summary": "returns forwarder-evc", "description": "returns forwarder-evc", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "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": "/getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc", "summary": "create or update an existing forwarder-evc", "description": "Create or update an existing forwarder-evc.\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": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "body", "type": "object", "info": "forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsFo...(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": "/createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc" }, "task": true }, { "name": "updateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc", "summary": "update an existing forwarder-evc", "description": "Update an existing forwarder-evc\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 requi...(description truncated)", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "type": "string" } }, { "name": "body", "type": "object", "info": "forwarder-evc 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": "/updateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc" }, "task": true }, { "name": "deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc", "summary": "delete an existing forwarder-evc", "description": "delete an existing forwarder-evc", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "forwarderEvcId", "type": "string", "info": "Key for forwarder-evc object", "required": true, "schema": { "title": "forwarderEvcId", "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": "/deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc" }, "task": true }, { "name": "getNetworkConfigurationsConfigurationForwarderEvcs", "summary": "returns forwarder-evcs", "description": "returns forwarder-evcs", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "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": "/getNetworkConfigurationsConfigurationForwarderEvcs" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "evcId", "type": "string", "info": "Unique/key field for the evc object", "required": true, "schema": { "title": "evcId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationEvcsEvc.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": "/createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "evcId", "type": "string", "info": "Unique/key field for the evc object", "required": true, "schema": { "title": "evcId", "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": "/deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship" }, "task": true }, { "name": "getNetworkConfigurationsConfigurationEvcsEvc", "summary": "returns evc", "description": "returns evc", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "evcId", "type": "string", "info": "Unique/key field for the evc object", "required": true, "schema": { "title": "evcId", "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": "/getNetworkConfigurationsConfigurationEvcsEvc" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfigurationEvcsEvc", "summary": "create or update an existing evc", "description": "Create or update an existing evc.\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": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "evcId", "type": "string", "info": "Unique/key field for the evc object", "required": true, "schema": { "title": "evcId", "type": "string" } }, { "name": "body", "type": "object", "info": "evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationEvcsEvc.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": "/createOrUpdateNetworkConfigurationsConfigurationEvcsEvc" }, "task": true }, { "name": "updateNetworkConfigurationsConfigurationEvcsEvc", "summary": "update an existing evc", "description": "Update an existing evc\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 values...(description truncated)", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "evcId", "type": "string", "info": "Unique/key field for the evc object", "required": true, "schema": { "title": "evcId", "type": "string" } }, { "name": "body", "type": "object", "info": "evc 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": "/updateNetworkConfigurationsConfigurationEvcsEvc" }, "task": true }, { "name": "deleteNetworkConfigurationsConfigurationEvcsEvc", "summary": "delete an existing evc", "description": "delete an existing evc", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "evcId", "type": "string", "info": "Unique/key field for the evc object", "required": true, "schema": { "title": "evcId", "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": "/deleteNetworkConfigurationsConfigurationEvcsEvc" }, "task": true }, { "name": "getNetworkConfigurationsConfigurationEvcs", "summary": "returns evcs", "description": "returns evcs", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "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": "/getNetworkConfigurationsConfigurationEvcs" }, "task": true }, { "name": "getNetworkConfigurationsConfiguration", "summary": "returns configuration", "description": "returns configuration", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "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": "/getNetworkConfigurationsConfiguration" }, "task": true }, { "name": "createOrUpdateNetworkConfigurationsConfiguration", "summary": "create or update an existing configuration", "description": "Create or update an existing configuration.\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": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfiguration.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": "/createOrUpdateNetworkConfigurationsConfiguration" }, "task": true }, { "name": "updateNetworkConfigurationsConfiguration", "summary": "update an existing configuration", "description": "Update an existing configuration\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 requi...(description truncated)", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "type": "string" } }, { "name": "body", "type": "object", "info": "configuration 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": "/updateNetworkConfigurationsConfiguration" }, "task": true }, { "name": "deleteNetworkConfigurationsConfiguration", "summary": "delete an existing configuration", "description": "delete an existing configuration", "input": [ { "name": "configurationId", "type": "string", "info": "UUID assigned to configuration.", "required": true, "schema": { "title": "configurationId", "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": "/deleteNetworkConfigurationsConfiguration" }, "task": true }, { "name": "getNetworkConfigurations", "summary": "returns configurations", "description": "returns configurations", "input": [ { "name": "configurationId", "type": "string", "info": "", "required": false, "schema": { "title": "configurationId", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkConfigurations" }, "task": true }, { "name": "createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPath.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": "/createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "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": "/deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship" }, "task": true }, { "name": "createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "sequence", "type": "number", "info": "Unique ID of this segmentation", "required": true, "schema": { "title": "sequence", "type": "number" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPathForwardersForw...(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": "/createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "sequence", "type": "number", "info": "Unique ID of this segmentation", "required": true, "schema": { "title": "sequence", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship" }, "task": true }, { "name": "getNetworkForwardingPathsForwardingPathForwardersForwarder", "summary": "returns forwarder", "description": "returns forwarder", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "sequence", "type": "number", "info": "Unique ID of this segmentation", "required": true, "schema": { "title": "sequence", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworkForwardingPathsForwardingPathForwardersForwarder" }, "task": true }, { "name": "createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder", "summary": "create or update an existing forwarder", "description": "Create or update an existing forwarder.\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": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "sequence", "type": "number", "info": "Unique ID of this segmentation", "required": true, "schema": { "title": "sequence", "type": "number" } }, { "name": "body", "type": "object", "info": "forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPathForwardersForward...(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": "/createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder" }, "task": true }, { "name": "updateNetworkForwardingPathsForwardingPathForwardersForwarder", "summary": "update an existing forwarder", "description": "Update an existing forwarder\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": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "sequence", "type": "number", "info": "Unique ID of this segmentation", "required": true, "schema": { "title": "sequence", "type": "number" } }, { "name": "body", "type": "object", "info": "forwarder 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": "/updateNetworkForwardingPathsForwardingPathForwardersForwarder" }, "task": true }, { "name": "deleteNetworkForwardingPathsForwardingPathForwardersForwarder", "summary": "delete an existing forwarder", "description": "delete an existing forwarder", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "sequence", "type": "number", "info": "Unique ID of this segmentation", "required": true, "schema": { "title": "sequence", "type": "number" } }, { "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": "/deleteNetworkForwardingPathsForwardingPathForwardersForwarder" }, "task": true }, { "name": "getNetworkForwardingPathsForwardingPathForwarders", "summary": "returns forwarders", "description": "returns forwarders", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "sequence", "type": "number", "info": "", "required": false, "schema": { "title": "sequence", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getNetworkForwardingPathsForwardingPathForwarders" }, "task": true }, { "name": "getNetworkForwardingPathsForwardingPath", "summary": "returns forwarding-path", "description": "returns forwarding-path", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "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": "/getNetworkForwardingPathsForwardingPath" }, "task": true }, { "name": "createOrUpdateNetworkForwardingPathsForwardingPath", "summary": "create or update an existing forwarding-path", "description": "Create or update an existing forwarding-path.\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": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "body", "type": "object", "info": "forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPath.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": "/createOrUpdateNetworkForwardingPathsForwardingPath" }, "task": true }, { "name": "updateNetworkForwardingPathsForwardingPath", "summary": "update an existing forwarding-path", "description": "Update an existing forwarding-path\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 req...(description truncated)", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "body", "type": "object", "info": "forwarding-path 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": "/updateNetworkForwardingPathsForwardingPath" }, "task": true }, { "name": "deleteNetworkForwardingPathsForwardingPath", "summary": "delete an existing forwarding-path", "description": "delete an existing forwarding-path", "input": [ { "name": "forwardingPathId", "type": "string", "info": "Unique ID of this FP", "required": true, "schema": { "title": "forwardingPathId", "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": "/deleteNetworkForwardingPathsForwardingPath" }, "task": true }, { "name": "getNetworkForwardingPaths", "summary": "returns forwarding-paths", "description": "returns forwarding-paths", "input": [ { "name": "forwardingPathId", "type": "string", "info": "", "required": false, "schema": { "title": "forwardingPathId", "type": "string" } }, { "name": "forwardingPathName", "type": "string", "info": "", "required": false, "schema": { "title": "forwardingPathName", "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": "/getNetworkForwardingPaths" }, "task": true }, { "name": "createOrUpdateNetworkCollectionsCollectionRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "collectionId", "type": "string", "info": "Collection Object UUID", "required": true, "schema": { "title": "collectionId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkCollectionsCollection.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": "/createOrUpdateNetworkCollectionsCollectionRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkCollectionsCollectionRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "collectionId", "type": "string", "info": "Collection Object UUID", "required": true, "schema": { "title": "collectionId", "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": "/deleteNetworkCollectionsCollectionRelationshipListRelationship" }, "task": true }, { "name": "getNetworkCollectionsCollection", "summary": "returns collection", "description": "returns collection", "input": [ { "name": "collectionId", "type": "string", "info": "Collection Object UUID", "required": true, "schema": { "title": "collectionId", "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": "/getNetworkCollectionsCollection" }, "task": true }, { "name": "createOrUpdateNetworkCollectionsCollection", "summary": "create or update an existing collection", "description": "Create or update an existing collection.\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": "collectionId", "type": "string", "info": "Collection Object UUID", "required": true, "schema": { "title": "collectionId", "type": "string" } }, { "name": "body", "type": "object", "info": "collection object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkCollectionsCollection.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": "/createOrUpdateNetworkCollectionsCollection" }, "task": true }, { "name": "updateNetworkCollectionsCollection", "summary": "update an existing collection", "description": "Update an existing collection\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": "collectionId", "type": "string", "info": "Collection Object UUID", "required": true, "schema": { "title": "collectionId", "type": "string" } }, { "name": "body", "type": "object", "info": "collection 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": "/updateNetworkCollectionsCollection" }, "task": true }, { "name": "deleteNetworkCollectionsCollection", "summary": "delete an existing collection", "description": "delete an existing collection", "input": [ { "name": "collectionId", "type": "string", "info": "Collection Object UUID", "required": true, "schema": { "title": "collectionId", "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": "/deleteNetworkCollectionsCollection" }, "task": true }, { "name": "getNetworkCollections", "summary": "returns collections", "description": "returns collections", "input": [ { "name": "collectionId", "type": "string", "info": "", "required": false, "schema": { "title": "collectionId", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkCollections" }, "task": true }, { "name": "createOrUpdateNetworkVlanTagsVlanTagRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "vlanTagId", "type": "string", "info": "Unique ID of the vlan-tag", "required": true, "schema": { "title": "vlanTagId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVlanTagsVlanTag.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": "/createOrUpdateNetworkVlanTagsVlanTagRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkVlanTagsVlanTagRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "vlanTagId", "type": "string", "info": "Unique ID of the vlan-tag", "required": true, "schema": { "title": "vlanTagId", "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": "/deleteNetworkVlanTagsVlanTagRelationshipListRelationship" }, "task": true }, { "name": "getNetworkVlanTagsVlanTag", "summary": "returns vlan-tag", "description": "returns vlan-tag", "input": [ { "name": "vlanTagId", "type": "string", "info": "Unique ID of the vlan-tag", "required": true, "schema": { "title": "vlanTagId", "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": "/getNetworkVlanTagsVlanTag" }, "task": true }, { "name": "createOrUpdateNetworkVlanTagsVlanTag", "summary": "create or update an existing vlan-tag", "description": "Create or update an existing vlan-tag.\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": "vlanTagId", "type": "string", "info": "Unique ID of the vlan-tag", "required": true, "schema": { "title": "vlanTagId", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan-tag object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVlanTagsVlanTag.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": "/createOrUpdateNetworkVlanTagsVlanTag" }, "task": true }, { "name": "updateNetworkVlanTagsVlanTag", "summary": "update an existing vlan-tag", "description": "Update an existing vlan-tag\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 v...(description truncated)", "input": [ { "name": "vlanTagId", "type": "string", "info": "Unique ID of the vlan-tag", "required": true, "schema": { "title": "vlanTagId", "type": "string" } }, { "name": "body", "type": "object", "info": "vlan-tag 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": "/updateNetworkVlanTagsVlanTag" }, "task": true }, { "name": "deleteNetworkVlanTagsVlanTag", "summary": "delete an existing vlan-tag", "description": "delete an existing vlan-tag", "input": [ { "name": "vlanTagId", "type": "string", "info": "Unique ID of the vlan-tag", "required": true, "schema": { "title": "vlanTagId", "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": "/deleteNetworkVlanTagsVlanTag" }, "task": true }, { "name": "getNetworkVlanTags", "summary": "returns vlan-tags", "description": "returns vlan-tags", "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": "/getNetworkVlanTags" }, "task": true }, { "name": "createOrUpdateNetworkConnectivitiesConnectivityRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "connectivityId", "type": "string", "info": "Uniquely identifies this connectivity by id", "required": true, "schema": { "title": "connectivityId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConnectivitiesConnectivity.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": "/createOrUpdateNetworkConnectivitiesConnectivityRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkConnectivitiesConnectivityRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "connectivityId", "type": "string", "info": "Uniquely identifies this connectivity by id", "required": true, "schema": { "title": "connectivityId", "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": "/deleteNetworkConnectivitiesConnectivityRelationshipListRelationship" }, "task": true }, { "name": "getNetworkConnectivitiesConnectivity", "summary": "returns connectivity", "description": "returns connectivity", "input": [ { "name": "connectivityId", "type": "string", "info": "Uniquely identifies this connectivity by id", "required": true, "schema": { "title": "connectivityId", "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": "/getNetworkConnectivitiesConnectivity" }, "task": true }, { "name": "createOrUpdateNetworkConnectivitiesConnectivity", "summary": "create or update an existing connectivity", "description": "Create or update an existing connectivity.\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": "connectivityId", "type": "string", "info": "Uniquely identifies this connectivity by id", "required": true, "schema": { "title": "connectivityId", "type": "string" } }, { "name": "body", "type": "object", "info": "connectivity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConnectivitiesConnectivity.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": "/createOrUpdateNetworkConnectivitiesConnectivity" }, "task": true }, { "name": "updateNetworkConnectivitiesConnectivity", "summary": "update an existing connectivity", "description": "Update an existing connectivity\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 requir...(description truncated)", "input": [ { "name": "connectivityId", "type": "string", "info": "Uniquely identifies this connectivity by id", "required": true, "schema": { "title": "connectivityId", "type": "string" } }, { "name": "body", "type": "object", "info": "connectivity 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": "/updateNetworkConnectivitiesConnectivity" }, "task": true }, { "name": "deleteNetworkConnectivitiesConnectivity", "summary": "delete an existing connectivity", "description": "delete an existing connectivity", "input": [ { "name": "connectivityId", "type": "string", "info": "Uniquely identifies this connectivity by id", "required": true, "schema": { "title": "connectivityId", "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": "/deleteNetworkConnectivitiesConnectivity" }, "task": true }, { "name": "getNetworkConnectivities", "summary": "returns connectivities", "description": "returns connectivities", "input": [ { "name": "connectivityId", "type": "string", "info": "", "required": false, "schema": { "title": "connectivityId", "type": "string" } }, { "name": "bandwidthProfileName", "type": "string", "info": "", "required": false, "schema": { "title": "bandwidthProfileName", "type": "string" } }, { "name": "vpnType", "type": "string", "info": "", "required": false, "schema": { "title": "vpnType", "type": "string" } }, { "name": "colorAware", "type": "string", "info": "", "required": false, "schema": { "title": "colorAware", "type": "string" } }, { "name": "couplingFlag", "type": "string", "info": "", "required": false, "schema": { "title": "couplingFlag", "type": "string" } }, { "name": "ethtSvcName", "type": "string", "info": "", "required": false, "schema": { "title": "ethtSvcName", "type": "string" } }, { "name": "accessProviderId", "type": "string", "info": "", "required": false, "schema": { "title": "accessProviderId", "type": "string" } }, { "name": "accessClientId", "type": "string", "info": "", "required": false, "schema": { "title": "accessClientId", "type": "string" } }, { "name": "accessTopologyId", "type": "string", "info": "", "required": false, "schema": { "title": "accessTopologyId", "type": "string" } }, { "name": "accessNodeId", "type": "string", "info": "", "required": false, "schema": { "title": "accessNodeId", "type": "string" } }, { "name": "accessLtpId", "type": "string", "info": "", "required": false, "schema": { "title": "accessLtpId", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkConnectivities" }, "task": true }, { "name": "createOrUpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpServiceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "dhcpServiceId", "type": "string", "info": "Uniquely identifies this dhcp-service by id", "required": true, "schema": { "title": "dhcpServiceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfigDhcpServicesDhcp...(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": "/createOrUpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpServiceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpServiceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "dhcpServiceId", "type": "string", "info": "Uniquely identifies this dhcp-service by id", "required": true, "schema": { "title": "dhcpServiceId", "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": "/deleteNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpServiceRelationshipListRelationship" }, "task": true }, { "name": "getNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService", "summary": "returns dhcp-service", "description": "returns dhcp-service", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "dhcpServiceId", "type": "string", "info": "Uniquely identifies this dhcp-service by id", "required": true, "schema": { "title": "dhcpServiceId", "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": "/getNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService" }, "task": true }, { "name": "createOrUpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService", "summary": "create or update an existing dhcp-service", "description": "Create or update an existing dhcp-service.\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": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "dhcpServiceId", "type": "string", "info": "Uniquely identifies this dhcp-service by id", "required": true, "schema": { "title": "dhcpServiceId", "type": "string" } }, { "name": "body", "type": "object", "info": "dhcp-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfigDhcpServicesDhcp...(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": "/createOrUpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService" }, "task": true }, { "name": "updateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService", "summary": "update an existing dhcp-service", "description": "Update an existing dhcp-service\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 requir...(description truncated)", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "dhcpServiceId", "type": "string", "info": "Uniquely identifies this dhcp-service by id", "required": true, "schema": { "title": "dhcpServiceId", "type": "string" } }, { "name": "body", "type": "object", "info": "dhcp-service 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": "/updateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService" }, "task": true }, { "name": "deleteNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService", "summary": "delete an existing dhcp-service", "description": "delete an existing dhcp-service", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "dhcpServiceId", "type": "string", "info": "Uniquely identifies this dhcp-service by id", "required": true, "schema": { "title": "dhcpServiceId", "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": "/deleteNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService" }, "task": true }, { "name": "getNetworkLanPortConfigsLanPortConfigDhcpServices", "summary": "returns dhcp-services", "description": "returns dhcp-services", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "dhcpServiceId", "type": "string", "info": "", "required": false, "schema": { "title": "dhcpServiceId", "type": "string" } }, { "name": "serverIpv4Address", "type": "string", "info": "", "required": false, "schema": { "title": "serverIpv4Address", "type": "string" } }, { "name": "serverIpv6Address", "type": "string", "info": "", "required": false, "schema": { "title": "serverIpv6Address", "type": "string" } }, { "name": "dhcpServiceType", "type": "string", "info": "", "required": false, "schema": { "title": "dhcpServiceType", "type": "string" } }, { "name": "domainName", "type": "string", "info": "", "required": false, "schema": { "title": "domainName", "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": "/getNetworkLanPortConfigsLanPortConfigDhcpServices" }, "task": true }, { "name": "createOrUpdateNetworkLanPortConfigsLanPortConfigRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfig.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": "/createOrUpdateNetworkLanPortConfigsLanPortConfigRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkLanPortConfigsLanPortConfigRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "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": "/deleteNetworkLanPortConfigsLanPortConfigRelationshipListRelationship" }, "task": true }, { "name": "getNetworkLanPortConfigsLanPortConfig", "summary": "returns lan-port-config", "description": "returns lan-port-config", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "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": "/getNetworkLanPortConfigsLanPortConfig" }, "task": true }, { "name": "createOrUpdateNetworkLanPortConfigsLanPortConfig", "summary": "create or update an existing lan-port-config", "description": "Create or update an existing lan-port-config.\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": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "body", "type": "object", "info": "lan-port-config object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfig.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": "/createOrUpdateNetworkLanPortConfigsLanPortConfig" }, "task": true }, { "name": "updateNetworkLanPortConfigsLanPortConfig", "summary": "update an existing lan-port-config", "description": "Update an existing lan-port-config\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 req...(description truncated)", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "body", "type": "object", "info": "lan-port-config 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": "/updateNetworkLanPortConfigsLanPortConfig" }, "task": true }, { "name": "deleteNetworkLanPortConfigsLanPortConfig", "summary": "delete an existing lan-port-config", "description": "delete an existing lan-port-config", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "Uniquely identifies this lan-port-config by id", "required": true, "schema": { "title": "lanPortConfigId", "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": "/deleteNetworkLanPortConfigsLanPortConfig" }, "task": true }, { "name": "getNetworkLanPortConfigs", "summary": "returns lan-port-configs", "description": "returns lan-port-configs", "input": [ { "name": "lanPortConfigId", "type": "string", "info": "", "required": false, "schema": { "title": "lanPortConfigId", "type": "string" } }, { "name": "lanPortConfigName", "type": "string", "info": "", "required": false, "schema": { "title": "lanPortConfigName", "type": "string" } }, { "name": "deviceId", "type": "string", "info": "", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "portId", "type": "string", "info": "", "required": false, "schema": { "title": "portId", "type": "string" } }, { "name": "ipv4Address", "type": "string", "info": "", "required": false, "schema": { "title": "ipv4Address", "type": "string" } }, { "name": "ipv6Address", "type": "string", "info": "", "required": false, "schema": { "title": "ipv6Address", "type": "string" } }, { "name": "vlanTag", "type": "string", "info": "", "required": false, "schema": { "title": "vlanTag", "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": "/getNetworkLanPortConfigs" }, "task": true }, { "name": "createOrUpdateNetworkNetworkResourcesNetworkResourceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "networkId", "type": "string", "info": "Uniquely identifies this network-resource by id", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkResourcesNetworkResource.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": "/createOrUpdateNetworkNetworkResourcesNetworkResourceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkNetworkResourcesNetworkResourceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "networkId", "type": "string", "info": "Uniquely identifies this network-resource by id", "required": true, "schema": { "title": "networkId", "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": "/deleteNetworkNetworkResourcesNetworkResourceRelationshipListRelationship" }, "task": true }, { "name": "getNetworkNetworkResourcesNetworkResource", "summary": "returns network-resource", "description": "returns network-resource", "input": [ { "name": "networkId", "type": "string", "info": "Uniquely identifies this network-resource by id", "required": true, "schema": { "title": "networkId", "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": "/getNetworkNetworkResourcesNetworkResource" }, "task": true }, { "name": "createOrUpdateNetworkNetworkResourcesNetworkResource", "summary": "create or update an existing network-resource", "description": "Create or update an existing network-resource.\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": "networkId", "type": "string", "info": "Uniquely identifies this network-resource by id", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "body", "type": "object", "info": "network-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkResourcesNetworkResource.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": "/createOrUpdateNetworkNetworkResourcesNetworkResource" }, "task": true }, { "name": "updateNetworkNetworkResourcesNetworkResource", "summary": "update an existing network-resource", "description": "Update an existing network-resource\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 re...(description truncated)", "input": [ { "name": "networkId", "type": "string", "info": "Uniquely identifies this network-resource by id", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "body", "type": "object", "info": "network-resource 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": "/updateNetworkNetworkResourcesNetworkResource" }, "task": true }, { "name": "deleteNetworkNetworkResourcesNetworkResource", "summary": "delete an existing network-resource", "description": "delete an existing network-resource", "input": [ { "name": "networkId", "type": "string", "info": "Uniquely identifies this network-resource by id", "required": true, "schema": { "title": "networkId", "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": "/deleteNetworkNetworkResourcesNetworkResource" }, "task": true }, { "name": "getNetworkNetworkResources", "summary": "returns network-resources", "description": "returns network-resources", "input": [ { "name": "networkId", "type": "string", "info": "", "required": false, "schema": { "title": "networkId", "type": "string" } }, { "name": "providerId", "type": "string", "info": "", "required": false, "schema": { "title": "providerId", "type": "string" } }, { "name": "clientId", "type": "string", "info": "", "required": false, "schema": { "title": "clientId", "type": "string" } }, { "name": "teTopoId", "type": "string", "info": "", "required": false, "schema": { "title": "teTopoId", "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": "/getNetworkNetworkResources" }, "task": true }, { "name": "createOrUpdateNetworkSiteResourcesSiteResourceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "siteResourceId", "type": "string", "info": "Uniquely identifies this site-resource by id", "required": true, "schema": { "title": "siteResourceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSiteResourcesSiteResource.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": "/createOrUpdateNetworkSiteResourcesSiteResourceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkSiteResourcesSiteResourceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "siteResourceId", "type": "string", "info": "Uniquely identifies this site-resource by id", "required": true, "schema": { "title": "siteResourceId", "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": "/deleteNetworkSiteResourcesSiteResourceRelationshipListRelationship" }, "task": true }, { "name": "getNetworkSiteResourcesSiteResource", "summary": "returns site-resource", "description": "returns site-resource", "input": [ { "name": "siteResourceId", "type": "string", "info": "Uniquely identifies this site-resource by id", "required": true, "schema": { "title": "siteResourceId", "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": "/getNetworkSiteResourcesSiteResource" }, "task": true }, { "name": "createOrUpdateNetworkSiteResourcesSiteResource", "summary": "create or update an existing site-resource", "description": "Create or update an existing site-resource.\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": "siteResourceId", "type": "string", "info": "Uniquely identifies this site-resource by id", "required": true, "schema": { "title": "siteResourceId", "type": "string" } }, { "name": "body", "type": "object", "info": "site-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSiteResourcesSiteResource.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": "/createOrUpdateNetworkSiteResourcesSiteResource" }, "task": true }, { "name": "updateNetworkSiteResourcesSiteResource", "summary": "update an existing site-resource", "description": "Update an existing site-resource\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 requi...(description truncated)", "input": [ { "name": "siteResourceId", "type": "string", "info": "Uniquely identifies this site-resource by id", "required": true, "schema": { "title": "siteResourceId", "type": "string" } }, { "name": "body", "type": "object", "info": "site-resource 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": "/updateNetworkSiteResourcesSiteResource" }, "task": true }, { "name": "deleteNetworkSiteResourcesSiteResource", "summary": "delete an existing site-resource", "description": "delete an existing site-resource", "input": [ { "name": "siteResourceId", "type": "string", "info": "Uniquely identifies this site-resource by id", "required": true, "schema": { "title": "siteResourceId", "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": "/deleteNetworkSiteResourcesSiteResource" }, "task": true }, { "name": "getNetworkSiteResources", "summary": "returns site-resources", "description": "returns site-resources", "input": [ { "name": "siteResourceId", "type": "string", "info": "", "required": false, "schema": { "title": "siteResourceId", "type": "string" } }, { "name": "siteResourceName", "type": "string", "info": "", "required": false, "schema": { "title": "siteResourceName", "type": "string" } }, { "name": "type", "type": "string", "info": "", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "role", "type": "string", "info": "", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "generatedSiteId", "type": "string", "info": "", "required": false, "schema": { "title": "generatedSiteId", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkSiteResources" }, "task": true }, { "name": "createOrUpdateNetworkSdwanVpnsSdwanVpnRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "sdwanVpnId", "type": "string", "info": "Uniquely identifies this sdwan-vpn by id", "required": true, "schema": { "title": "sdwanVpnId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSdwanVpnsSdwanVpn.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": "/createOrUpdateNetworkSdwanVpnsSdwanVpnRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkSdwanVpnsSdwanVpnRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "sdwanVpnId", "type": "string", "info": "Uniquely identifies this sdwan-vpn by id", "required": true, "schema": { "title": "sdwanVpnId", "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": "/deleteNetworkSdwanVpnsSdwanVpnRelationshipListRelationship" }, "task": true }, { "name": "getNetworkSdwanVpnsSdwanVpn", "summary": "returns sdwan-vpn", "description": "returns sdwan-vpn", "input": [ { "name": "sdwanVpnId", "type": "string", "info": "Uniquely identifies this sdwan-vpn by id", "required": true, "schema": { "title": "sdwanVpnId", "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": "/getNetworkSdwanVpnsSdwanVpn" }, "task": true }, { "name": "createOrUpdateNetworkSdwanVpnsSdwanVpn", "summary": "create or update an existing sdwan-vpn", "description": "Create or update an existing sdwan-vpn.\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": "sdwanVpnId", "type": "string", "info": "Uniquely identifies this sdwan-vpn by id", "required": true, "schema": { "title": "sdwanVpnId", "type": "string" } }, { "name": "body", "type": "object", "info": "sdwan-vpn object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSdwanVpnsSdwanVpn.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": "/createOrUpdateNetworkSdwanVpnsSdwanVpn" }, "task": true }, { "name": "updateNetworkSdwanVpnsSdwanVpn", "summary": "update an existing sdwan-vpn", "description": "Update an existing sdwan-vpn\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": "sdwanVpnId", "type": "string", "info": "Uniquely identifies this sdwan-vpn by id", "required": true, "schema": { "title": "sdwanVpnId", "type": "string" } }, { "name": "body", "type": "object", "info": "sdwan-vpn 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": "/updateNetworkSdwanVpnsSdwanVpn" }, "task": true }, { "name": "deleteNetworkSdwanVpnsSdwanVpn", "summary": "delete an existing sdwan-vpn", "description": "delete an existing sdwan-vpn", "input": [ { "name": "sdwanVpnId", "type": "string", "info": "Uniquely identifies this sdwan-vpn by id", "required": true, "schema": { "title": "sdwanVpnId", "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": "/deleteNetworkSdwanVpnsSdwanVpn" }, "task": true }, { "name": "getNetworkSdwanVpns", "summary": "returns sdwan-vpns", "description": "returns sdwan-vpns", "input": [ { "name": "sdwanVpnId", "type": "string", "info": "", "required": false, "schema": { "title": "sdwanVpnId", "type": "string" } }, { "name": "sdwanVpnName", "type": "string", "info": "", "required": false, "schema": { "title": "sdwanVpnName", "type": "string" } }, { "name": "vxlanId", "type": "string", "info": "", "required": false, "schema": { "title": "vxlanId", "type": "string" } }, { "name": "topology", "type": "string", "info": "", "required": false, "schema": { "title": "topology", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkSdwanVpns" }, "task": true }, { "name": "createOrUpdateNetworkDevicesDeviceRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "deviceId", "type": "string", "info": "Uniquely identifies this device by id", "required": true, "schema": { "title": "deviceId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkDevicesDevice.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": "/createOrUpdateNetworkDevicesDeviceRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkDevicesDeviceRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "deviceId", "type": "string", "info": "Uniquely identifies this device by id", "required": true, "schema": { "title": "deviceId", "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": "/deleteNetworkDevicesDeviceRelationshipListRelationship" }, "task": true }, { "name": "getNetworkDevicesDevice", "summary": "returns device", "description": "returns device", "input": [ { "name": "deviceId", "type": "string", "info": "Uniquely identifies this device by id", "required": true, "schema": { "title": "deviceId", "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": "/getNetworkDevicesDevice" }, "task": true }, { "name": "createOrUpdateNetworkDevicesDevice", "summary": "create or update an existing device", "description": "Create or update an existing device.\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": "deviceId", "type": "string", "info": "Uniquely identifies this device by id", "required": true, "schema": { "title": "deviceId", "type": "string" } }, { "name": "body", "type": "object", "info": "device object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkDevicesDevice.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": "/createOrUpdateNetworkDevicesDevice" }, "task": true }, { "name": "updateNetworkDevicesDevice", "summary": "update an existing device", "description": "Update an existing device\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 val...(description truncated)", "input": [ { "name": "deviceId", "type": "string", "info": "Uniquely identifies this device by id", "required": true, "schema": { "title": "deviceId", "type": "string" } }, { "name": "body", "type": "object", "info": "device 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": "/updateNetworkDevicesDevice" }, "task": true }, { "name": "deleteNetworkDevicesDevice", "summary": "delete an existing device", "description": "delete an existing device", "input": [ { "name": "deviceId", "type": "string", "info": "Uniquely identifies this device by id", "required": true, "schema": { "title": "deviceId", "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": "/deleteNetworkDevicesDevice" }, "task": true }, { "name": "getNetworkDevices", "summary": "returns devices", "description": "returns devices", "input": [ { "name": "deviceId", "type": "string", "info": "", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "esn", "type": "string", "info": "", "required": false, "schema": { "title": "esn", "type": "string" } }, { "name": "deviceName", "type": "string", "info": "", "required": false, "schema": { "title": "deviceName", "type": "string" } }, { "name": "vendor", "type": "string", "info": "", "required": false, "schema": { "title": "vendor", "type": "string" } }, { "name": "classParam", "type": "string", "info": "", "required": false, "schema": { "title": "classParam", "type": "string" } }, { "name": "type", "type": "string", "info": "", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "version", "type": "string", "info": "", "required": false, "schema": { "title": "version", "type": "string" } }, { "name": "systemIp", "type": "string", "info": "", "required": false, "schema": { "title": "systemIp", "type": "string" } }, { "name": "systemIpv4", "type": "string", "info": "", "required": false, "schema": { "title": "systemIpv4", "type": "string" } }, { "name": "systemIpv6", "type": "string", "info": "", "required": false, "schema": { "title": "systemIpv6", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkDevices" }, "task": true }, { "name": "createOrUpdateNetworkWanPortConfigsWanPortConfigRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "wanPortConfigId", "type": "string", "info": "Uniquely identifies this wan-port-config by id", "required": true, "schema": { "title": "wanPortConfigId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkWanPortConfigsWanPortConfig.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": "/createOrUpdateNetworkWanPortConfigsWanPortConfigRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkWanPortConfigsWanPortConfigRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "wanPortConfigId", "type": "string", "info": "Uniquely identifies this wan-port-config by id", "required": true, "schema": { "title": "wanPortConfigId", "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": "/deleteNetworkWanPortConfigsWanPortConfigRelationshipListRelationship" }, "task": true }, { "name": "getNetworkWanPortConfigsWanPortConfig", "summary": "returns wan-port-config", "description": "returns wan-port-config", "input": [ { "name": "wanPortConfigId", "type": "string", "info": "Uniquely identifies this wan-port-config by id", "required": true, "schema": { "title": "wanPortConfigId", "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": "/getNetworkWanPortConfigsWanPortConfig" }, "task": true }, { "name": "createOrUpdateNetworkWanPortConfigsWanPortConfig", "summary": "create or update an existing wan-port-config", "description": "Create or update an existing wan-port-config.\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": "wanPortConfigId", "type": "string", "info": "Uniquely identifies this wan-port-config by id", "required": true, "schema": { "title": "wanPortConfigId", "type": "string" } }, { "name": "body", "type": "object", "info": "wan-port-config object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkWanPortConfigsWanPortConfig.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": "/createOrUpdateNetworkWanPortConfigsWanPortConfig" }, "task": true }, { "name": "updateNetworkWanPortConfigsWanPortConfig", "summary": "update an existing wan-port-config", "description": "Update an existing wan-port-config\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 req...(description truncated)", "input": [ { "name": "wanPortConfigId", "type": "string", "info": "Uniquely identifies this wan-port-config by id", "required": true, "schema": { "title": "wanPortConfigId", "type": "string" } }, { "name": "body", "type": "object", "info": "wan-port-config 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": "/updateNetworkWanPortConfigsWanPortConfig" }, "task": true }, { "name": "deleteNetworkWanPortConfigsWanPortConfig", "summary": "delete an existing wan-port-config", "description": "delete an existing wan-port-config", "input": [ { "name": "wanPortConfigId", "type": "string", "info": "Uniquely identifies this wan-port-config by id", "required": true, "schema": { "title": "wanPortConfigId", "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": "/deleteNetworkWanPortConfigsWanPortConfig" }, "task": true }, { "name": "getNetworkWanPortConfigs", "summary": "returns wan-port-configs", "description": "returns wan-port-configs", "input": [ { "name": "wanPortConfigId", "type": "string", "info": "", "required": false, "schema": { "title": "wanPortConfigId", "type": "string" } }, { "name": "wanPortConfigName", "type": "string", "info": "", "required": false, "schema": { "title": "wanPortConfigName", "type": "string" } }, { "name": "deviceId", "type": "string", "info": "", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "ipAddress", "type": "string", "info": "", "required": false, "schema": { "title": "ipAddress", "type": "string" } }, { "name": "ipv4Address", "type": "string", "info": "", "required": false, "schema": { "title": "ipv4Address", "type": "string" } }, { "name": "ipv6Address", "type": "string", "info": "", "required": false, "schema": { "title": "ipv6Address", "type": "string" } }, { "name": "portType", "type": "string", "info": "", "required": false, "schema": { "title": "portType", "type": "string" } }, { "name": "portNumber", "type": "string", "info": "", "required": false, "schema": { "title": "portNumber", "type": "string" } }, { "name": "devicePortId", "type": "string", "info": "", "required": false, "schema": { "title": "devicePortId", "type": "string" } }, { "name": "wanPortId", "type": "string", "info": "", "required": false, "schema": { "title": "wanPortId", "type": "string" } }, { "name": "operationalStatus", "type": "string", "info": "", "required": false, "schema": { "title": "operationalStatus", "type": "string" } }, { "name": "modelInvariantId", "type": "string", "info": "", "required": false, "schema": { "title": "modelInvariantId", "type": "string" } }, { "name": "modelVersionId", "type": "string", "info": "", "required": false, "schema": { "title": "modelVersionId", "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": "/getNetworkWanPortConfigs" }, "task": true }, { "name": "createOrUpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfoRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo.js...(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": "/createOrUpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfoRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfoRelationshipListRelationship" }, "task": true }, { "name": "getNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo", "summary": "returns esr-system-info", "description": "returns esr-system-info", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/getNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo" }, "task": true }, { "name": "createOrUpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo", "summary": "create or update an existing esr-system-info", "description": "Create or update an existing esr-system-info.\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": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo...(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": "/createOrUpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo" }, "task": true }, { "name": "updateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo", "summary": "update an existing esr-system-info", "description": "Update an existing esr-system-info\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 req...(description truncated)", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "type": "string" } }, { "name": "body", "type": "object", "info": "esr-system-info 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": "/updateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo" }, "task": true }, { "name": "deleteNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo", "summary": "delete an existing esr-system-info", "description": "delete an existing esr-system-info", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "esrSystemInfoId", "type": "string", "info": "Unique ID of esr system info.", "required": true, "schema": { "title": "esrSystemInfoId", "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": "/deleteNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo" }, "task": true }, { "name": "createOrUpdateNetworkExtAaiNetworksExtAaiNetworkRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetwork.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": "/createOrUpdateNetworkExtAaiNetworksExtAaiNetworkRelationshipListRelationship" }, "task": true }, { "name": "deleteNetworkExtAaiNetworksExtAaiNetworkRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "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": "/deleteNetworkExtAaiNetworksExtAaiNetworkRelationshipListRelationship" }, "task": true }, { "name": "getNetworkExtAaiNetworksExtAaiNetwork", "summary": "returns ext-aai-network", "description": "returns ext-aai-network", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "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": "/getNetworkExtAaiNetworksExtAaiNetwork" }, "task": true }, { "name": "createOrUpdateNetworkExtAaiNetworksExtAaiNetwork", "summary": "create or update an existing ext-aai-network", "description": "Create or update an existing ext-aai-network.\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": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "body", "type": "object", "info": "ext-aai-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetwork.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": "/createOrUpdateNetworkExtAaiNetworksExtAaiNetwork" }, "task": true }, { "name": "updateNetworkExtAaiNetworksExtAaiNetwork", "summary": "update an existing ext-aai-network", "description": "Update an existing ext-aai-network\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 req...(description truncated)", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "type": "string" } }, { "name": "body", "type": "object", "info": "ext-aai-network 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": "/updateNetworkExtAaiNetworksExtAaiNetwork" }, "task": true }, { "name": "deleteNetworkExtAaiNetworksExtAaiNetwork", "summary": "delete an existing ext-aai-network", "description": "delete an existing ext-aai-network", "input": [ { "name": "aaiId", "type": "string", "info": "Unique ID of the referenced AAI.", "required": true, "schema": { "title": "aaiId", "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": "/deleteNetworkExtAaiNetworksExtAaiNetwork" }, "task": true }, { "name": "getNetworkExtAaiNetworks", "summary": "returns ext-aai-networks", "description": "returns ext-aai-networks", "input": [ { "name": "aaiId", "type": "string", "info": "", "required": false, "schema": { "title": "aaiId", "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": "/getNetworkExtAaiNetworks" }, "task": true }, { "name": "createOrUpdateCommonContactsContactRelationshipListRelationship", "summary": "see node definition for valid relationships", "description": "see node definition for valid relationships", "input": [ { "name": "contactName", "type": "string", "info": "Name of the contact", "required": true, "schema": { "title": "contactName", "type": "string" } }, { "name": "body", "type": "object", "info": "relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CommonContactsContact.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": "/createOrUpdateCommonContactsContactRelationshipListRelationship" }, "task": true }, { "name": "deleteCommonContactsContactRelationshipListRelationship", "summary": "delete an existing relationship", "description": "delete an existing relationship", "input": [ { "name": "contactName", "type": "string", "info": "Name of the contact", "required": true, "schema": { "title": "contactName", "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": "/deleteCommonContactsContactRelationshipListRelationship" }, "task": true }, { "name": "getCommonContactsContact", "summary": "returns contact", "description": "returns contact", "input": [ { "name": "contactName", "type": "string", "info": "Name of the contact", "required": true, "schema": { "title": "contactName", "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": "/getCommonContactsContact" }, "task": true }, { "name": "createOrUpdateCommonContactsContact", "summary": "create or update an existing contact", "description": "Create or update an existing contact.\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": "contactName", "type": "string", "info": "Name of the contact", "required": true, "schema": { "title": "contactName", "type": "string" } }, { "name": "body", "type": "object", "info": "contact object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CommonContactsContact.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": "/createOrUpdateCommonContactsContact" }, "task": true }, { "name": "updateCommonContactsContact", "summary": "update an existing contact", "description": "Update an existing contact\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": "contactName", "type": "string", "info": "Name of the contact", "required": true, "schema": { "title": "contactName", "type": "string" } }, { "name": "body", "type": "object", "info": "contact 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": "/updateCommonContactsContact" }, "task": true }, { "name": "deleteCommonContactsContact", "summary": "delete an existing contact", "description": "delete an existing contact", "input": [ { "name": "contactName", "type": "string", "info": "Name of the contact", "required": true, "schema": { "title": "contactName", "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": "/deleteCommonContactsContact" }, "task": true }, { "name": "getCommonContacts", "summary": "returns contacts", "description": "returns contacts", "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": "/getCommonContacts" }, "task": true } ] }