{ "id": "@itentialopensource/adapter-netbox_v33", "type": "Adapter", "export": "NetboxV33", "title": "Netbox_v33", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "getCircuitsCircuitTerminations", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "termSide", "type": "string", "info": ": string", "required": false, "schema": { "title": "termSide", "type": "string" } }, { "name": "portSpeed", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeed", "type": "string" } }, { "name": "upstreamSpeed", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeed", "type": "string" } }, { "name": "xconnectId", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectId", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "circuitId", "type": "string", "info": ": string", "required": false, "schema": { "title": "circuitId", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "providerNetworkId", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerNetworkId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "termSideN", "type": "string", "info": ": string", "required": false, "schema": { "title": "termSideN", "type": "string" } }, { "name": "portSpeedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedN", "type": "string" } }, { "name": "portSpeedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedLte", "type": "string" } }, { "name": "portSpeedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedLt", "type": "string" } }, { "name": "portSpeedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedGte", "type": "string" } }, { "name": "portSpeedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "portSpeedGt", "type": "string" } }, { "name": "upstreamSpeedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedN", "type": "string" } }, { "name": "upstreamSpeedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedLte", "type": "string" } }, { "name": "upstreamSpeedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedLt", "type": "string" } }, { "name": "upstreamSpeedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedGte", "type": "string" } }, { "name": "upstreamSpeedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "upstreamSpeedGt", "type": "string" } }, { "name": "xconnectIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdN", "type": "string" } }, { "name": "xconnectIdIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdIc", "type": "string" } }, { "name": "xconnectIdNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdNic", "type": "string" } }, { "name": "xconnectIdIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdIew", "type": "string" } }, { "name": "xconnectIdNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdNiew", "type": "string" } }, { "name": "xconnectIdIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdIsw", "type": "string" } }, { "name": "xconnectIdNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdNisw", "type": "string" } }, { "name": "xconnectIdIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdIe", "type": "string" } }, { "name": "xconnectIdNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "xconnectIdNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "circuitIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "circuitIdN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "providerNetworkIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerNetworkIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "circuit", "term_side" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "circuit": { "required": [ "cid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 } } }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "provider_network": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 }, "pp_info": { "title": "Patch panel/port(s)", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCircuitsCircuitTerminations" }, "task": true }, { "name": "postCircuitsCircuitTerminations", "summary": "circuits_circuit-terminations_create", "description": "circuits_circuit-terminations_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"circuit\": 123, \"term_side\": \"Must be one of [A, Z]\", \"site\": 123, \"provider_network\": 123, \"port_speed\": 123, \"upstream_speed\": 123, \"xconnect_id\": \"string\", \"pp_info\": \"string\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "circuit", "term_side" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "circuit": { "title": "Circuit", "type": "integer" }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "provider_network": { "title": "Provider network", "type": "integer", "x-nullable": true }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 }, "pp_info": { "title": "Patch panel/port(s)", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCircuitsCircuitTerminations" }, "task": true }, { "name": "putCircuitsCircuitTerminations", "summary": "circuits_circuit-terminations_bulk_update", "description": "circuits_circuit-terminations_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"circuit\": 123, \"term_side\": \"Must be one of [A, Z]\", \"site\": 123, \"provider_network\": 123, \"port_speed\": 123, \"upstream_speed\": 123, \"xconnect_id\": \"string\", \"pp_info\": \"string\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "circuit", "term_side" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "circuit": { "title": "Circuit", "type": "integer" }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "provider_network": { "title": "Provider network", "type": "integer", "x-nullable": true }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 }, "pp_info": { "title": "Patch panel/port(s)", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsCircuitTerminations" }, "task": true }, { "name": "patchCircuitsCircuitTerminations", "summary": "circuits_circuit-terminations_bulk_partial_update", "description": "circuits_circuit-terminations_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"circuit\": 123, \"term_side\": \"Must be one of [A, Z]\", \"site\": 123, \"provider_network\": 123, \"port_speed\": 123, \"upstream_speed\": 123, \"xconnect_id\": \"string\", \"pp_info\": \"string\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "circuit", "term_side" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "circuit": { "title": "Circuit", "type": "integer" }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "provider_network": { "title": "Provider network", "type": "integer", "x-nullable": true }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 }, "pp_info": { "title": "Patch panel/port(s)", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsCircuitTerminations" }, "task": true }, { "name": "deleteCircuitsCircuitTerminations", "summary": "circuits_circuit-terminations_bulk_delete", "description": "circuits_circuit-terminations_bulk_delete", "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": "/deleteCircuitsCircuitTerminations" }, "task": true }, { "name": "getCircuitsCircuitTerminationsId", "summary": "circuits_circuit-terminations_read", "description": "circuits_circuit-terminations_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit termination.: 123", "required": true, "schema": { "title": "id", "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": "/getCircuitsCircuitTerminationsId" }, "task": true }, { "name": "putCircuitsCircuitTerminationsId", "summary": "circuits_circuit-terminations_update", "description": "circuits_circuit-terminations_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit termination.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"circuit\": 123, \"term_side\": \"Must be one of [A, Z]\", \"site\": 123, \"provider_network\": 123, \"port_speed\": 123, \"upstream_speed\": 123, \"xconnect_id\": \"string\", \"pp_info\": \"string\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "circuit", "term_side" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "circuit": { "title": "Circuit", "type": "integer" }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "provider_network": { "title": "Provider network", "type": "integer", "x-nullable": true }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 }, "pp_info": { "title": "Patch panel/port(s)", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsCircuitTerminationsId" }, "task": true }, { "name": "patchCircuitsCircuitTerminationsId", "summary": "circuits_circuit-terminations_partial_update", "description": "circuits_circuit-terminations_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit termination.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"circuit\": 123, \"term_side\": \"Must be one of [A, Z]\", \"site\": 123, \"provider_network\": 123, \"port_speed\": 123, \"upstream_speed\": 123, \"xconnect_id\": \"string\", \"pp_info\": \"string\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "circuit", "term_side" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "circuit": { "title": "Circuit", "type": "integer" }, "term_side": { "title": "Termination", "type": "string", "enum": [ "A", "Z" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "provider_network": { "title": "Provider network", "type": "integer", "x-nullable": true }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 }, "pp_info": { "title": "Patch panel/port(s)", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsCircuitTerminationsId" }, "task": true }, { "name": "deleteCircuitsCircuitTerminationsId", "summary": "circuits_circuit-terminations_delete", "description": "circuits_circuit-terminations_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit termination.: 123", "required": true, "schema": { "title": "id", "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": "/deleteCircuitsCircuitTerminationsId" }, "task": true }, { "name": "getCircuitsCircuitTerminationsIdPaths", "summary": "Return all CablePaths which traverse a given pass-through port.", "description": "Return all CablePaths which traverse a given pass-through port.", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit termination.: 123", "required": true, "schema": { "title": "id", "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": "/getCircuitsCircuitTerminationsIdPaths" }, "task": true }, { "name": "getCircuitsCircuitTypes", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCircuitsCircuitTypes" }, "task": true }, { "name": "postCircuitsCircuitTypes", "summary": "circuits_circuit-types_create", "description": "circuits_circuit-types_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCircuitsCircuitTypes" }, "task": true }, { "name": "putCircuitsCircuitTypes", "summary": "circuits_circuit-types_bulk_update", "description": "circuits_circuit-types_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsCircuitTypes" }, "task": true }, { "name": "patchCircuitsCircuitTypes", "summary": "circuits_circuit-types_bulk_partial_update", "description": "circuits_circuit-types_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsCircuitTypes" }, "task": true }, { "name": "deleteCircuitsCircuitTypes", "summary": "circuits_circuit-types_bulk_delete", "description": "circuits_circuit-types_bulk_delete", "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": "/deleteCircuitsCircuitTypes" }, "task": true }, { "name": "getCircuitsCircuitTypesId", "summary": "circuits_circuit-types_read", "description": "circuits_circuit-types_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit type.: 123", "required": true, "schema": { "title": "id", "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": "/getCircuitsCircuitTypesId" }, "task": true }, { "name": "putCircuitsCircuitTypesId", "summary": "circuits_circuit-types_update", "description": "circuits_circuit-types_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit type.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsCircuitTypesId" }, "task": true }, { "name": "patchCircuitsCircuitTypesId", "summary": "circuits_circuit-types_partial_update", "description": "circuits_circuit-types_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit type.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsCircuitTypesId" }, "task": true }, { "name": "deleteCircuitsCircuitTypesId", "summary": "circuits_circuit-types_delete", "description": "circuits_circuit-types_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit type.: 123", "required": true, "schema": { "title": "id", "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": "/deleteCircuitsCircuitTypesId" }, "task": true }, { "name": "getCircuitsCircuits", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "cid", "type": "string", "info": ": string", "required": false, "schema": { "title": "cid", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "installDate", "type": "string", "info": ": string", "required": false, "schema": { "title": "installDate", "type": "string" } }, { "name": "terminationDate", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationDate", "type": "string" } }, { "name": "commitRate", "type": "string", "info": ": string", "required": false, "schema": { "title": "commitRate", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "providerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerId", "type": "string" } }, { "name": "provider", "type": "string", "info": ": string", "required": false, "schema": { "title": "provider", "type": "string" } }, { "name": "providerNetworkId", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerNetworkId", "type": "string" } }, { "name": "typeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeId", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "cidN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidN", "type": "string" } }, { "name": "cidIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidIc", "type": "string" } }, { "name": "cidNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidNic", "type": "string" } }, { "name": "cidIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidIew", "type": "string" } }, { "name": "cidNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidNiew", "type": "string" } }, { "name": "cidIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidIsw", "type": "string" } }, { "name": "cidNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidNisw", "type": "string" } }, { "name": "cidIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidIe", "type": "string" } }, { "name": "cidNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "cidNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "installDateN", "type": "string", "info": ": string", "required": false, "schema": { "title": "installDateN", "type": "string" } }, { "name": "installDateLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "installDateLte", "type": "string" } }, { "name": "installDateLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "installDateLt", "type": "string" } }, { "name": "installDateGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "installDateGte", "type": "string" } }, { "name": "installDateGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "installDateGt", "type": "string" } }, { "name": "terminationDateN", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationDateN", "type": "string" } }, { "name": "terminationDateLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationDateLte", "type": "string" } }, { "name": "terminationDateLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationDateLt", "type": "string" } }, { "name": "terminationDateGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationDateGte", "type": "string" } }, { "name": "terminationDateGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationDateGt", "type": "string" } }, { "name": "commitRateN", "type": "string", "info": ": string", "required": false, "schema": { "title": "commitRateN", "type": "string" } }, { "name": "commitRateLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "commitRateLte", "type": "string" } }, { "name": "commitRateLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "commitRateLt", "type": "string" } }, { "name": "commitRateGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "commitRateGte", "type": "string" } }, { "name": "commitRateGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "commitRateGt", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "providerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerIdN", "type": "string" } }, { "name": "providerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerN", "type": "string" } }, { "name": "providerNetworkIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerNetworkIdN", "type": "string" } }, { "name": "typeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeIdN", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "cid", "provider", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 }, "provider": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } } }, "type": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } } }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Planned", "Provisioning", "Active", "Offline", "Deprovisioning", "Decommissioned" ] }, "value": { "type": "string", "enum": [ "planned", "provisioning", "active", "offline", "deprovisioning", "decommissioned" ] } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "install_date": { "title": "Installed", "type": "string", "x-nullable": true }, "termination_date": { "title": "Terminates", "type": "string", "x-nullable": true }, "commit_rate": { "title": "Commit rate (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "termination_a": { "required": [ "site", "provider_network" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "provider_network": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 } } }, "termination_z": { "required": [ "site", "provider_network" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "provider_network": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "port_speed": { "title": "Port speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "upstream_speed": { "title": "Upstream speed (Kbps)", "description": "Upstream speed, if different from port speed", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "xconnect_id": { "title": "Cross-connect ID", "type": "string", "maxLength": 50 } } }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCircuitsCircuits" }, "task": true }, { "name": "postCircuitsCircuits", "summary": "circuits_circuits_create", "description": "circuits_circuits_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cid\": \"string\", \"provider\": 123, \"type\": 123, \"status\": \"Must be one of [planned, provisioning, active, offline, deprovisioning, decommissioned]\", \"tenant\": 123, \"install_date\": \"string\", \"termination_date\": \"string\", \"commit_rate\": 123, \"description\": \"string\", \"termination_a\": 123, \"termination_z\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "cid", "provider", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 }, "provider": { "title": "Provider", "type": "integer" }, "type": { "title": "Type", "type": "integer" }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "provisioning", "active", "offline", "deprovisioning", "decommissioned" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "install_date": { "title": "Installed", "type": "string", "x-nullable": true }, "termination_date": { "title": "Terminates", "type": "string", "x-nullable": true }, "commit_rate": { "title": "Commit rate (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "termination_a": { "title": "Termination a", "type": "integer", "readOnly": true, "x-nullable": true }, "termination_z": { "title": "Termination z", "type": "integer", "readOnly": true, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCircuitsCircuits" }, "task": true }, { "name": "putCircuitsCircuits", "summary": "circuits_circuits_bulk_update", "description": "circuits_circuits_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cid\": \"string\", \"provider\": 123, \"type\": 123, \"status\": \"Must be one of [planned, provisioning, active, offline, deprovisioning, decommissioned]\", \"tenant\": 123, \"install_date\": \"string\", \"termination_date\": \"string\", \"commit_rate\": 123, \"description\": \"string\", \"termination_a\": 123, \"termination_z\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "cid", "provider", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 }, "provider": { "title": "Provider", "type": "integer" }, "type": { "title": "Type", "type": "integer" }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "provisioning", "active", "offline", "deprovisioning", "decommissioned" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "install_date": { "title": "Installed", "type": "string", "x-nullable": true }, "termination_date": { "title": "Terminates", "type": "string", "x-nullable": true }, "commit_rate": { "title": "Commit rate (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "termination_a": { "title": "Termination a", "type": "integer", "readOnly": true, "x-nullable": true }, "termination_z": { "title": "Termination z", "type": "integer", "readOnly": true, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsCircuits" }, "task": true }, { "name": "patchCircuitsCircuits", "summary": "circuits_circuits_bulk_partial_update", "description": "circuits_circuits_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cid\": \"string\", \"provider\": 123, \"type\": 123, \"status\": \"Must be one of [planned, provisioning, active, offline, deprovisioning, decommissioned]\", \"tenant\": 123, \"install_date\": \"string\", \"termination_date\": \"string\", \"commit_rate\": 123, \"description\": \"string\", \"termination_a\": 123, \"termination_z\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "cid", "provider", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 }, "provider": { "title": "Provider", "type": "integer" }, "type": { "title": "Type", "type": "integer" }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "provisioning", "active", "offline", "deprovisioning", "decommissioned" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "install_date": { "title": "Installed", "type": "string", "x-nullable": true }, "termination_date": { "title": "Terminates", "type": "string", "x-nullable": true }, "commit_rate": { "title": "Commit rate (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "termination_a": { "title": "Termination a", "type": "integer", "readOnly": true, "x-nullable": true }, "termination_z": { "title": "Termination z", "type": "integer", "readOnly": true, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsCircuits" }, "task": true }, { "name": "deleteCircuitsCircuits", "summary": "circuits_circuits_bulk_delete", "description": "circuits_circuits_bulk_delete", "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": "/deleteCircuitsCircuits" }, "task": true }, { "name": "getCircuitsCircuitsId", "summary": "circuits_circuits_read", "description": "circuits_circuits_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit.: 123", "required": true, "schema": { "title": "id", "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": "/getCircuitsCircuitsId" }, "task": true }, { "name": "putCircuitsCircuitsId", "summary": "circuits_circuits_update", "description": "circuits_circuits_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cid\": \"string\", \"provider\": 123, \"type\": 123, \"status\": \"Must be one of [planned, provisioning, active, offline, deprovisioning, decommissioned]\", \"tenant\": 123, \"install_date\": \"string\", \"termination_date\": \"string\", \"commit_rate\": 123, \"description\": \"string\", \"termination_a\": 123, \"termination_z\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "cid", "provider", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 }, "provider": { "title": "Provider", "type": "integer" }, "type": { "title": "Type", "type": "integer" }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "provisioning", "active", "offline", "deprovisioning", "decommissioned" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "install_date": { "title": "Installed", "type": "string", "x-nullable": true }, "termination_date": { "title": "Terminates", "type": "string", "x-nullable": true }, "commit_rate": { "title": "Commit rate (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "termination_a": { "title": "Termination a", "type": "integer", "readOnly": true, "x-nullable": true }, "termination_z": { "title": "Termination z", "type": "integer", "readOnly": true, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsCircuitsId" }, "task": true }, { "name": "patchCircuitsCircuitsId", "summary": "circuits_circuits_partial_update", "description": "circuits_circuits_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cid\": \"string\", \"provider\": 123, \"type\": 123, \"status\": \"Must be one of [planned, provisioning, active, offline, deprovisioning, decommissioned]\", \"tenant\": 123, \"install_date\": \"string\", \"termination_date\": \"string\", \"commit_rate\": 123, \"description\": \"string\", \"termination_a\": 123, \"termination_z\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "cid", "provider", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cid": { "title": "Circuit ID", "type": "string", "maxLength": 100, "minLength": 1 }, "provider": { "title": "Provider", "type": "integer" }, "type": { "title": "Type", "type": "integer" }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "provisioning", "active", "offline", "deprovisioning", "decommissioned" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "install_date": { "title": "Installed", "type": "string", "x-nullable": true }, "termination_date": { "title": "Terminates", "type": "string", "x-nullable": true }, "commit_rate": { "title": "Commit rate (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "termination_a": { "title": "Termination a", "type": "integer", "readOnly": true, "x-nullable": true }, "termination_z": { "title": "Termination z", "type": "integer", "readOnly": true, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsCircuitsId" }, "task": true }, { "name": "deleteCircuitsCircuitsId", "summary": "circuits_circuits_delete", "description": "circuits_circuits_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this circuit.: 123", "required": true, "schema": { "title": "id", "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": "/deleteCircuitsCircuitsId" }, "task": true }, { "name": "getCircuitsProviderNetworks", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "serviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceId", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "providerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerId", "type": "string" } }, { "name": "provider", "type": "string", "info": ": string", "required": false, "schema": { "title": "provider", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "serviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdN", "type": "string" } }, { "name": "serviceIdIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdIc", "type": "string" } }, { "name": "serviceIdNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdNic", "type": "string" } }, { "name": "serviceIdIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdIew", "type": "string" } }, { "name": "serviceIdNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdNiew", "type": "string" } }, { "name": "serviceIdIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdIsw", "type": "string" } }, { "name": "serviceIdNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdNisw", "type": "string" } }, { "name": "serviceIdIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdIe", "type": "string" } }, { "name": "serviceIdNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "serviceIdNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "providerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerIdN", "type": "string" } }, { "name": "providerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "providerN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "provider", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "provider": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_id": { "title": "Service ID", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCircuitsProviderNetworks" }, "task": true }, { "name": "postCircuitsProviderNetworks", "summary": "circuits_provider-networks_create", "description": "circuits_provider-networks_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"provider\": 123, \"name\": \"string\", \"service_id\": \"string\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "provider", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "provider": { "title": "Provider", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_id": { "title": "Service ID", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCircuitsProviderNetworks" }, "task": true }, { "name": "putCircuitsProviderNetworks", "summary": "circuits_provider-networks_bulk_update", "description": "circuits_provider-networks_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"provider\": 123, \"name\": \"string\", \"service_id\": \"string\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "provider", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "provider": { "title": "Provider", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_id": { "title": "Service ID", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsProviderNetworks" }, "task": true }, { "name": "patchCircuitsProviderNetworks", "summary": "circuits_provider-networks_bulk_partial_update", "description": "circuits_provider-networks_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"provider\": 123, \"name\": \"string\", \"service_id\": \"string\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "provider", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "provider": { "title": "Provider", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_id": { "title": "Service ID", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsProviderNetworks" }, "task": true }, { "name": "deleteCircuitsProviderNetworks", "summary": "circuits_provider-networks_bulk_delete", "description": "circuits_provider-networks_bulk_delete", "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": "/deleteCircuitsProviderNetworks" }, "task": true }, { "name": "getCircuitsProviderNetworksId", "summary": "circuits_provider-networks_read", "description": "circuits_provider-networks_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this provider network.: 123", "required": true, "schema": { "title": "id", "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": "/getCircuitsProviderNetworksId" }, "task": true }, { "name": "putCircuitsProviderNetworksId", "summary": "circuits_provider-networks_update", "description": "circuits_provider-networks_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this provider network.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"provider\": 123, \"name\": \"string\", \"service_id\": \"string\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "provider", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "provider": { "title": "Provider", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_id": { "title": "Service ID", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsProviderNetworksId" }, "task": true }, { "name": "patchCircuitsProviderNetworksId", "summary": "circuits_provider-networks_partial_update", "description": "circuits_provider-networks_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this provider network.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"provider\": 123, \"name\": \"string\", \"service_id\": \"string\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "provider", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "provider": { "title": "Provider", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_id": { "title": "Service ID", "type": "string", "maxLength": 100 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsProviderNetworksId" }, "task": true }, { "name": "deleteCircuitsProviderNetworksId", "summary": "circuits_provider-networks_delete", "description": "circuits_provider-networks_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this provider network.: 123", "required": true, "schema": { "title": "id", "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": "/deleteCircuitsProviderNetworksId" }, "task": true }, { "name": "getCircuitsProviders", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "asn", "type": "string", "info": ": string", "required": false, "schema": { "title": "asn", "type": "string" } }, { "name": "account", "type": "string", "info": ": string", "required": false, "schema": { "title": "account", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "asnId", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "asnN", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnN", "type": "string" } }, { "name": "asnLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnLte", "type": "string" } }, { "name": "asnLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnLt", "type": "string" } }, { "name": "asnGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnGte", "type": "string" } }, { "name": "asnGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnGt", "type": "string" } }, { "name": "accountN", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountN", "type": "string" } }, { "name": "accountIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountIc", "type": "string" } }, { "name": "accountNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountNic", "type": "string" } }, { "name": "accountIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountIew", "type": "string" } }, { "name": "accountNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountNiew", "type": "string" } }, { "name": "accountIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountIsw", "type": "string" } }, { "name": "accountNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountNisw", "type": "string" } }, { "name": "accountIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountIe", "type": "string" } }, { "name": "accountNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "accountNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "asnIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1, "x-nullable": true }, "account": { "title": "Account number", "type": "string", "maxLength": 30 }, "portal_url": { "title": "Portal URL", "type": "string", "maxLength": 200 }, "noc_contact": { "title": "NOC contact", "type": "string" }, "admin_contact": { "title": "Admin contact", "type": "string" }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "required": [ "asn" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1 } } }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCircuitsProviders" }, "task": true }, { "name": "postCircuitsProviders", "summary": "circuits_providers_create", "description": "circuits_providers_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"asn\": 123, \"account\": \"string\", \"portal_url\": \"string\", \"noc_contact\": \"string\", \"admin_contact\": \"string\", \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1, "x-nullable": true }, "account": { "title": "Account number", "type": "string", "maxLength": 30 }, "portal_url": { "title": "Portal URL", "type": "string", "maxLength": 200 }, "noc_contact": { "title": "NOC contact", "type": "string" }, "admin_contact": { "title": "Admin contact", "type": "string" }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCircuitsProviders" }, "task": true }, { "name": "putCircuitsProviders", "summary": "circuits_providers_bulk_update", "description": "circuits_providers_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"asn\": 123, \"account\": \"string\", \"portal_url\": \"string\", \"noc_contact\": \"string\", \"admin_contact\": \"string\", \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1, "x-nullable": true }, "account": { "title": "Account number", "type": "string", "maxLength": 30 }, "portal_url": { "title": "Portal URL", "type": "string", "maxLength": 200 }, "noc_contact": { "title": "NOC contact", "type": "string" }, "admin_contact": { "title": "Admin contact", "type": "string" }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsProviders" }, "task": true }, { "name": "patchCircuitsProviders", "summary": "circuits_providers_bulk_partial_update", "description": "circuits_providers_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"asn\": 123, \"account\": \"string\", \"portal_url\": \"string\", \"noc_contact\": \"string\", \"admin_contact\": \"string\", \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1, "x-nullable": true }, "account": { "title": "Account number", "type": "string", "maxLength": 30 }, "portal_url": { "title": "Portal URL", "type": "string", "maxLength": 200 }, "noc_contact": { "title": "NOC contact", "type": "string" }, "admin_contact": { "title": "Admin contact", "type": "string" }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsProviders" }, "task": true }, { "name": "deleteCircuitsProviders", "summary": "circuits_providers_bulk_delete", "description": "circuits_providers_bulk_delete", "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": "/deleteCircuitsProviders" }, "task": true }, { "name": "getCircuitsProvidersId", "summary": "circuits_providers_read", "description": "circuits_providers_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this provider.: 123", "required": true, "schema": { "title": "id", "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": "/getCircuitsProvidersId" }, "task": true }, { "name": "putCircuitsProvidersId", "summary": "circuits_providers_update", "description": "circuits_providers_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this provider.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"asn\": 123, \"account\": \"string\", \"portal_url\": \"string\", \"noc_contact\": \"string\", \"admin_contact\": \"string\", \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1, "x-nullable": true }, "account": { "title": "Account number", "type": "string", "maxLength": 30 }, "portal_url": { "title": "Portal URL", "type": "string", "maxLength": 200 }, "noc_contact": { "title": "NOC contact", "type": "string" }, "admin_contact": { "title": "Admin contact", "type": "string" }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putCircuitsProvidersId" }, "task": true }, { "name": "patchCircuitsProvidersId", "summary": "circuits_providers_partial_update", "description": "circuits_providers_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this provider.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"asn\": 123, \"account\": \"string\", \"portal_url\": \"string\", \"noc_contact\": \"string\", \"admin_contact\": \"string\", \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1, "x-nullable": true }, "account": { "title": "Account number", "type": "string", "maxLength": 30 }, "portal_url": { "title": "Portal URL", "type": "string", "maxLength": 200 }, "noc_contact": { "title": "NOC contact", "type": "string" }, "admin_contact": { "title": "Admin contact", "type": "string" }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchCircuitsProvidersId" }, "task": true }, { "name": "deleteCircuitsProvidersId", "summary": "circuits_providers_delete", "description": "circuits_providers_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this provider.: 123", "required": true, "schema": { "title": "id", "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": "/deleteCircuitsProvidersId" }, "task": true }, { "name": "getDcimCableTerminations", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "cable", "type": "string", "info": ": string", "required": false, "schema": { "title": "cable", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "terminationType", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationType", "type": "string" } }, { "name": "terminationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "cableN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableN", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "terminationTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationTypeN", "type": "string" } }, { "name": "terminationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationIdN", "type": "string" } }, { "name": "terminationIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationIdLte", "type": "string" } }, { "name": "terminationIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationIdLt", "type": "string" } }, { "name": "terminationIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationIdGte", "type": "string" } }, { "name": "terminationIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationIdGt", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "cable", "cable_end", "termination_type", "termination_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cable": { "title": "Cable", "type": "integer" }, "cable_end": { "title": "End", "type": "string", "enum": [ "A", "B" ] }, "termination_type": { "title": "Termination type", "type": "string" }, "termination_id": { "title": "Termination id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "termination": { "title": "Termination", "type": "object", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimCableTerminations" }, "task": true }, { "name": "postDcimCableTerminations", "summary": "dcim_cable-terminations_create", "description": "dcim_cable-terminations_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cable\": 123, \"cable_end\": \"Must be one of [A, B]\", \"termination_type\": \"string\", \"termination_id\": 123, \"termination\": \"object\"}", "required": true, "schema": { "required": [ "cable", "cable_end", "termination_type", "termination_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cable": { "title": "Cable", "type": "integer" }, "cable_end": { "title": "End", "type": "string", "enum": [ "A", "B" ] }, "termination_type": { "title": "Termination type", "type": "string" }, "termination_id": { "title": "Termination id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "termination": { "title": "Termination", "type": "object", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimCableTerminations" }, "task": true }, { "name": "putDcimCableTerminations", "summary": "dcim_cable-terminations_bulk_update", "description": "dcim_cable-terminations_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cable\": 123, \"cable_end\": \"Must be one of [A, B]\", \"termination_type\": \"string\", \"termination_id\": 123, \"termination\": \"object\"}", "required": true, "schema": { "required": [ "cable", "cable_end", "termination_type", "termination_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cable": { "title": "Cable", "type": "integer" }, "cable_end": { "title": "End", "type": "string", "enum": [ "A", "B" ] }, "termination_type": { "title": "Termination type", "type": "string" }, "termination_id": { "title": "Termination id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "termination": { "title": "Termination", "type": "object", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimCableTerminations" }, "task": true }, { "name": "patchDcimCableTerminations", "summary": "dcim_cable-terminations_bulk_partial_update", "description": "dcim_cable-terminations_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cable\": 123, \"cable_end\": \"Must be one of [A, B]\", \"termination_type\": \"string\", \"termination_id\": 123, \"termination\": \"object\"}", "required": true, "schema": { "required": [ "cable", "cable_end", "termination_type", "termination_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cable": { "title": "Cable", "type": "integer" }, "cable_end": { "title": "End", "type": "string", "enum": [ "A", "B" ] }, "termination_type": { "title": "Termination type", "type": "string" }, "termination_id": { "title": "Termination id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "termination": { "title": "Termination", "type": "object", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimCableTerminations" }, "task": true }, { "name": "deleteDcimCableTerminations", "summary": "dcim_cable-terminations_bulk_delete", "description": "dcim_cable-terminations_bulk_delete", "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": "/deleteDcimCableTerminations" }, "task": true }, { "name": "getDcimCableTerminationsId", "summary": "dcim_cable-terminations_read", "description": "dcim_cable-terminations_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cable termination.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimCableTerminationsId" }, "task": true }, { "name": "putDcimCableTerminationsId", "summary": "dcim_cable-terminations_update", "description": "dcim_cable-terminations_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cable termination.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cable\": 123, \"cable_end\": \"Must be one of [A, B]\", \"termination_type\": \"string\", \"termination_id\": 123, \"termination\": \"object\"}", "required": true, "schema": { "required": [ "cable", "cable_end", "termination_type", "termination_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cable": { "title": "Cable", "type": "integer" }, "cable_end": { "title": "End", "type": "string", "enum": [ "A", "B" ] }, "termination_type": { "title": "Termination type", "type": "string" }, "termination_id": { "title": "Termination id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "termination": { "title": "Termination", "type": "object", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimCableTerminationsId" }, "task": true }, { "name": "patchDcimCableTerminationsId", "summary": "dcim_cable-terminations_partial_update", "description": "dcim_cable-terminations_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cable termination.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"cable\": 123, \"cable_end\": \"Must be one of [A, B]\", \"termination_type\": \"string\", \"termination_id\": 123, \"termination\": \"object\"}", "required": true, "schema": { "required": [ "cable", "cable_end", "termination_type", "termination_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "cable": { "title": "Cable", "type": "integer" }, "cable_end": { "title": "End", "type": "string", "enum": [ "A", "B" ] }, "termination_type": { "title": "Termination type", "type": "string" }, "termination_id": { "title": "Termination id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "termination": { "title": "Termination", "type": "object", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimCableTerminationsId" }, "task": true }, { "name": "deleteDcimCableTerminationsId", "summary": "dcim_cable-terminations_delete", "description": "dcim_cable-terminations_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cable termination.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimCableTerminationsId" }, "task": true }, { "name": "getDcimCables", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "length", "type": "string", "info": ": string", "required": false, "schema": { "title": "length", "type": "string" } }, { "name": "lengthUnit", "type": "string", "info": ": string", "required": false, "schema": { "title": "lengthUnit", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "terminationAType", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationAType", "type": "string" } }, { "name": "terminationAId", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationAId", "type": "string" } }, { "name": "terminationBType", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationBType", "type": "string" } }, { "name": "terminationBId", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationBId", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "lengthN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lengthN", "type": "string" } }, { "name": "lengthLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lengthLte", "type": "string" } }, { "name": "lengthLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lengthLt", "type": "string" } }, { "name": "lengthGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lengthGte", "type": "string" } }, { "name": "lengthGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lengthGt", "type": "string" } }, { "name": "lengthUnitN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lengthUnitN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "terminationATypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationATypeN", "type": "string" } }, { "name": "terminationAIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationAIdN", "type": "string" } }, { "name": "terminationAIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationAIdLte", "type": "string" } }, { "name": "terminationAIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationAIdLt", "type": "string" } }, { "name": "terminationAIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationAIdGte", "type": "string" } }, { "name": "terminationAIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationAIdGt", "type": "string" } }, { "name": "terminationBTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationBTypeN", "type": "string" } }, { "name": "terminationBIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationBIdN", "type": "string" } }, { "name": "terminationBIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationBIdLte", "type": "string" } }, { "name": "terminationBIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationBIdLt", "type": "string" } }, { "name": "terminationBIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationBIdGte", "type": "string" } }, { "name": "terminationBIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "terminationBIdGt", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "type": { "title": "Type", "type": "string", "enum": [ "cat3", "cat5", "cat5e", "cat6", "cat6a", "cat7", "cat7a", "cat8", "dac-active", "dac-passive", "mrj21-trunk", "coaxial", "mmf", "mmf-om1", "mmf-om2", "mmf-om3", "mmf-om4", "mmf-om5", "smf", "smf-os1", "smf-os2", "aoc", "power" ] }, "a_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "b_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Connected", "Planned", "Decommissioning" ] }, "value": { "type": "string", "enum": [ "connected", "planned", "decommissioning" ] } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "length": { "title": "Length", "type": "number", "x-nullable": true }, "length_unit": { "title": "Length unit", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Kilometers", "Meters", "Centimeters", "Miles", "Feet", "Inches" ] }, "value": { "type": "string", "enum": [ "km", "m", "cm", "mi", "ft", "in" ] } } }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimCables" }, "task": true }, { "name": "postDcimCables", "summary": "dcim_cables_create", "description": "dcim_cables_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"type\": \"Must be one of [cat3, cat5, cat5e, cat6, cat6a, cat7, cat7a, cat8, dac-active, dac-passive, mrj21-trunk, coaxial, mmf, mmf-om1, mmf-om2, mmf-om3, mmf-om4, mmf-om5, smf, smf-os1, smf-os2, aoc, power]\", \"a_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"b_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"label\": \"string\", \"color\": \"string\", \"length\": 123, \"length_unit\": \"Must be one of [km, m, cm, mi, ft, in]\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "type": { "title": "Type", "type": "string", "enum": [ "cat3", "cat5", "cat5e", "cat6", "cat6a", "cat7", "cat7a", "cat8", "dac-active", "dac-passive", "mrj21-trunk", "coaxial", "mmf", "mmf-om1", "mmf-om2", "mmf-om3", "mmf-om4", "mmf-om5", "smf", "smf-os1", "smf-os2", "aoc", "power" ] }, "a_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "b_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "length": { "title": "Length", "type": "number", "x-nullable": true }, "length_unit": { "title": "Length unit", "type": "string", "enum": [ "km", "m", "cm", "mi", "ft", "in" ] }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimCables" }, "task": true }, { "name": "putDcimCables", "summary": "dcim_cables_bulk_update", "description": "dcim_cables_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"type\": \"Must be one of [cat3, cat5, cat5e, cat6, cat6a, cat7, cat7a, cat8, dac-active, dac-passive, mrj21-trunk, coaxial, mmf, mmf-om1, mmf-om2, mmf-om3, mmf-om4, mmf-om5, smf, smf-os1, smf-os2, aoc, power]\", \"a_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"b_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"label\": \"string\", \"color\": \"string\", \"length\": 123, \"length_unit\": \"Must be one of [km, m, cm, mi, ft, in]\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "type": { "title": "Type", "type": "string", "enum": [ "cat3", "cat5", "cat5e", "cat6", "cat6a", "cat7", "cat7a", "cat8", "dac-active", "dac-passive", "mrj21-trunk", "coaxial", "mmf", "mmf-om1", "mmf-om2", "mmf-om3", "mmf-om4", "mmf-om5", "smf", "smf-os1", "smf-os2", "aoc", "power" ] }, "a_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "b_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "length": { "title": "Length", "type": "number", "x-nullable": true }, "length_unit": { "title": "Length unit", "type": "string", "enum": [ "km", "m", "cm", "mi", "ft", "in" ] }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimCables" }, "task": true }, { "name": "patchDcimCables", "summary": "dcim_cables_bulk_partial_update", "description": "dcim_cables_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"type\": \"Must be one of [cat3, cat5, cat5e, cat6, cat6a, cat7, cat7a, cat8, dac-active, dac-passive, mrj21-trunk, coaxial, mmf, mmf-om1, mmf-om2, mmf-om3, mmf-om4, mmf-om5, smf, smf-os1, smf-os2, aoc, power]\", \"a_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"b_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"label\": \"string\", \"color\": \"string\", \"length\": 123, \"length_unit\": \"Must be one of [km, m, cm, mi, ft, in]\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "type": { "title": "Type", "type": "string", "enum": [ "cat3", "cat5", "cat5e", "cat6", "cat6a", "cat7", "cat7a", "cat8", "dac-active", "dac-passive", "mrj21-trunk", "coaxial", "mmf", "mmf-om1", "mmf-om2", "mmf-om3", "mmf-om4", "mmf-om5", "smf", "smf-os1", "smf-os2", "aoc", "power" ] }, "a_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "b_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "length": { "title": "Length", "type": "number", "x-nullable": true }, "length_unit": { "title": "Length unit", "type": "string", "enum": [ "km", "m", "cm", "mi", "ft", "in" ] }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimCables" }, "task": true }, { "name": "deleteDcimCables", "summary": "dcim_cables_bulk_delete", "description": "dcim_cables_bulk_delete", "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": "/deleteDcimCables" }, "task": true }, { "name": "getDcimCablesId", "summary": "dcim_cables_read", "description": "dcim_cables_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cable.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimCablesId" }, "task": true }, { "name": "putDcimCablesId", "summary": "dcim_cables_update", "description": "dcim_cables_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cable.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"type\": \"Must be one of [cat3, cat5, cat5e, cat6, cat6a, cat7, cat7a, cat8, dac-active, dac-passive, mrj21-trunk, coaxial, mmf, mmf-om1, mmf-om2, mmf-om3, mmf-om4, mmf-om5, smf, smf-os1, smf-os2, aoc, power]\", \"a_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"b_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"label\": \"string\", \"color\": \"string\", \"length\": 123, \"length_unit\": \"Must be one of [km, m, cm, mi, ft, in]\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "type": { "title": "Type", "type": "string", "enum": [ "cat3", "cat5", "cat5e", "cat6", "cat6a", "cat7", "cat7a", "cat8", "dac-active", "dac-passive", "mrj21-trunk", "coaxial", "mmf", "mmf-om1", "mmf-om2", "mmf-om3", "mmf-om4", "mmf-om5", "smf", "smf-os1", "smf-os2", "aoc", "power" ] }, "a_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "b_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "length": { "title": "Length", "type": "number", "x-nullable": true }, "length_unit": { "title": "Length unit", "type": "string", "enum": [ "km", "m", "cm", "mi", "ft", "in" ] }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimCablesId" }, "task": true }, { "name": "patchDcimCablesId", "summary": "dcim_cables_partial_update", "description": "dcim_cables_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cable.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"type\": \"Must be one of [cat3, cat5, cat5e, cat6, cat6a, cat7, cat7a, cat8, dac-active, dac-passive, mrj21-trunk, coaxial, mmf, mmf-om1, mmf-om2, mmf-om3, mmf-om4, mmf-om5, smf, smf-os1, smf-os2, aoc, power]\", \"a_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"b_terminations\": [{\"object_type\": \"string\", \"object_id\": 123, \"object\": \"object\"}], \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"label\": \"string\", \"color\": \"string\", \"length\": 123, \"length_unit\": \"Must be one of [km, m, cm, mi, ft, in]\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "type": { "title": "Type", "type": "string", "enum": [ "cat3", "cat5", "cat5e", "cat6", "cat6a", "cat7", "cat7a", "cat8", "dac-active", "dac-passive", "mrj21-trunk", "coaxial", "mmf", "mmf-om1", "mmf-om2", "mmf-om3", "mmf-om4", "mmf-om5", "smf", "smf-os1", "smf-os2", "aoc", "power" ] }, "a_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "b_terminations": { "type": "array", "items": { "required": [ "object_type", "object_id" ], "type": "object", "properties": { "object_type": { "title": "Object type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer" }, "object": { "title": "Object", "type": "object", "readOnly": true } } } }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "length": { "title": "Length", "type": "number", "x-nullable": true }, "length_unit": { "title": "Length unit", "type": "string", "enum": [ "km", "m", "cm", "mi", "ft", "in" ] }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimCablesId" }, "task": true }, { "name": "deleteDcimCablesId", "summary": "dcim_cables_delete", "description": "dcim_cables_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cable.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimCablesId" }, "task": true }, { "name": "getDcimConnectedDevice", "summary": "This endpoint allows a user to determine what device (if any) is connected to a given peer device a", "description": "This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer\ninterface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors\nvia a protocol such as LLDP. Two query parameters must be included in the request:\n\n* `peer_device`: The name of the peer device\n* `peer_interface`: The name of the peer interface", "input": [ { "name": "peerDevice", "type": "string", "info": "The name of the peer device: string", "required": true, "schema": { "title": "peerDevice", "type": "string" } }, { "name": "peerInterface", "type": "string", "info": "The name of the peer interface: string", "required": true, "schema": { "title": "peerInterface", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimConnectedDevice" }, "task": true }, { "name": "getDcimConsolePortTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "moduletypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "moduletypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "DE-9", "DB-25", "RJ-11", "RJ-12", "RJ-45", "Mini-DIN 8", "USB Type A", "USB Type B", "USB Type C", "USB Mini A", "USB Mini B", "USB Micro A", "USB Micro B", "USB Micro AB", "Other" ] }, "value": { "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] } } }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimConsolePortTemplates" }, "task": true }, { "name": "postDcimConsolePortTemplates", "summary": "dcim_console-port-templates_create", "description": "dcim_console-port-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimConsolePortTemplates" }, "task": true }, { "name": "putDcimConsolePortTemplates", "summary": "dcim_console-port-templates_bulk_update", "description": "dcim_console-port-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimConsolePortTemplates" }, "task": true }, { "name": "patchDcimConsolePortTemplates", "summary": "dcim_console-port-templates_bulk_partial_update", "description": "dcim_console-port-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimConsolePortTemplates" }, "task": true }, { "name": "deleteDcimConsolePortTemplates", "summary": "dcim_console-port-templates_bulk_delete", "description": "dcim_console-port-templates_bulk_delete", "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": "/deleteDcimConsolePortTemplates" }, "task": true }, { "name": "getDcimConsolePortTemplatesId", "summary": "dcim_console-port-templates_read", "description": "dcim_console-port-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimConsolePortTemplatesId" }, "task": true }, { "name": "putDcimConsolePortTemplatesId", "summary": "dcim_console-port-templates_update", "description": "dcim_console-port-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimConsolePortTemplatesId" }, "task": true }, { "name": "patchDcimConsolePortTemplatesId", "summary": "dcim_console-port-templates_partial_update", "description": "dcim_console-port-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimConsolePortTemplatesId" }, "task": true }, { "name": "deleteDcimConsolePortTemplatesId", "summary": "dcim_console-port-templates_delete", "description": "dcim_console-port-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimConsolePortTemplatesId" }, "task": true }, { "name": "getDcimConsolePorts", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "moduleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "connected", "type": "string", "info": ": string", "required": false, "schema": { "title": "connected", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "moduleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleIdN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module": { "required": [ "device" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "DE-9", "DB-25", "RJ-11", "RJ-12", "RJ-45", "Mini-DIN 8", "USB Type A", "USB Type B", "USB Type C", "USB Mini A", "USB Mini B", "USB Micro A", "USB Micro B", "USB Micro AB", "Other" ] }, "value": { "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] } } }, "speed": { "title": "Speed", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "1200 bps", "2400 bps", "4800 bps", "9600 bps", "19.2 kbps", "38.4 kbps", "57.6 kbps", "115.2 kbps" ] }, "value": { "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ] } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimConsolePorts" }, "task": true }, { "name": "postDcimConsolePorts", "summary": "dcim_console-ports_create", "description": "dcim_console-ports_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimConsolePorts" }, "task": true }, { "name": "putDcimConsolePorts", "summary": "dcim_console-ports_bulk_update", "description": "dcim_console-ports_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimConsolePorts" }, "task": true }, { "name": "patchDcimConsolePorts", "summary": "dcim_console-ports_bulk_partial_update", "description": "dcim_console-ports_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimConsolePorts" }, "task": true }, { "name": "deleteDcimConsolePorts", "summary": "dcim_console-ports_bulk_delete", "description": "dcim_console-ports_bulk_delete", "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": "/deleteDcimConsolePorts" }, "task": true }, { "name": "getDcimConsolePortsId", "summary": "dcim_console-ports_read", "description": "dcim_console-ports_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimConsolePortsId" }, "task": true }, { "name": "putDcimConsolePortsId", "summary": "dcim_console-ports_update", "description": "dcim_console-ports_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimConsolePortsId" }, "task": true }, { "name": "patchDcimConsolePortsId", "summary": "dcim_console-ports_partial_update", "description": "dcim_console-ports_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimConsolePortsId" }, "task": true }, { "name": "deleteDcimConsolePortsId", "summary": "dcim_console-ports_delete", "description": "dcim_console-ports_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimConsolePortsId" }, "task": true }, { "name": "getDcimConsolePortsIdTrace", "summary": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin", "description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimConsolePortsIdTrace" }, "task": true }, { "name": "getDcimConsoleServerPortTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "moduletypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "moduletypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "DE-9", "DB-25", "RJ-11", "RJ-12", "RJ-45", "Mini-DIN 8", "USB Type A", "USB Type B", "USB Type C", "USB Mini A", "USB Mini B", "USB Micro A", "USB Micro B", "USB Micro AB", "Other" ] }, "value": { "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] } } }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimConsoleServerPortTemplates" }, "task": true }, { "name": "postDcimConsoleServerPortTemplates", "summary": "dcim_console-server-port-templates_create", "description": "dcim_console-server-port-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimConsoleServerPortTemplates" }, "task": true }, { "name": "putDcimConsoleServerPortTemplates", "summary": "dcim_console-server-port-templates_bulk_update", "description": "dcim_console-server-port-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimConsoleServerPortTemplates" }, "task": true }, { "name": "patchDcimConsoleServerPortTemplates", "summary": "dcim_console-server-port-templates_bulk_partial_update", "description": "dcim_console-server-port-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimConsoleServerPortTemplates" }, "task": true }, { "name": "deleteDcimConsoleServerPortTemplates", "summary": "dcim_console-server-port-templates_bulk_delete", "description": "dcim_console-server-port-templates_bulk_delete", "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": "/deleteDcimConsoleServerPortTemplates" }, "task": true }, { "name": "getDcimConsoleServerPortTemplatesId", "summary": "dcim_console-server-port-templates_read", "description": "dcim_console-server-port-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimConsoleServerPortTemplatesId" }, "task": true }, { "name": "putDcimConsoleServerPortTemplatesId", "summary": "dcim_console-server-port-templates_update", "description": "dcim_console-server-port-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimConsoleServerPortTemplatesId" }, "task": true }, { "name": "patchDcimConsoleServerPortTemplatesId", "summary": "dcim_console-server-port-templates_partial_update", "description": "dcim_console-server-port-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimConsoleServerPortTemplatesId" }, "task": true }, { "name": "deleteDcimConsoleServerPortTemplatesId", "summary": "dcim_console-server-port-templates_delete", "description": "dcim_console-server-port-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimConsoleServerPortTemplatesId" }, "task": true }, { "name": "getDcimConsoleServerPorts", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "moduleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "connected", "type": "string", "info": ": string", "required": false, "schema": { "title": "connected", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "moduleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleIdN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module": { "required": [ "device" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "DE-9", "DB-25", "RJ-11", "RJ-12", "RJ-45", "Mini-DIN 8", "USB Type A", "USB Type B", "USB Type C", "USB Mini A", "USB Mini B", "USB Micro A", "USB Micro B", "USB Micro AB", "Other" ] }, "value": { "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] } } }, "speed": { "title": "Speed", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "1200 bps", "2400 bps", "4800 bps", "9600 bps", "19.2 kbps", "38.4 kbps", "57.6 kbps", "115.2 kbps" ] }, "value": { "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ] } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimConsoleServerPorts" }, "task": true }, { "name": "postDcimConsoleServerPorts", "summary": "dcim_console-server-ports_create", "description": "dcim_console-server-ports_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimConsoleServerPorts" }, "task": true }, { "name": "putDcimConsoleServerPorts", "summary": "dcim_console-server-ports_bulk_update", "description": "dcim_console-server-ports_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimConsoleServerPorts" }, "task": true }, { "name": "patchDcimConsoleServerPorts", "summary": "dcim_console-server-ports_bulk_partial_update", "description": "dcim_console-server-ports_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimConsoleServerPorts" }, "task": true }, { "name": "deleteDcimConsoleServerPorts", "summary": "dcim_console-server-ports_bulk_delete", "description": "dcim_console-server-ports_bulk_delete", "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": "/deleteDcimConsoleServerPorts" }, "task": true }, { "name": "getDcimConsoleServerPortsId", "summary": "dcim_console-server-ports_read", "description": "dcim_console-server-ports_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimConsoleServerPortsId" }, "task": true }, { "name": "putDcimConsoleServerPortsId", "summary": "dcim_console-server-ports_update", "description": "dcim_console-server-ports_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimConsoleServerPortsId" }, "task": true }, { "name": "patchDcimConsoleServerPortsId", "summary": "dcim_console-server-ports_partial_update", "description": "dcim_console-server-ports_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [de-9, db-25, rj-11, rj-12, rj-45, mini-din-8, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, other]\", \"speed\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "de-9", "db-25", "rj-11", "rj-12", "rj-45", "mini-din-8", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "other" ] }, "speed": { "title": "Speed", "description": "Port speed in bits per second", "type": "integer", "enum": [ 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 ], "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimConsoleServerPortsId" }, "task": true }, { "name": "deleteDcimConsoleServerPortsId", "summary": "dcim_console-server-ports_delete", "description": "dcim_console-server-ports_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimConsoleServerPortsId" }, "task": true }, { "name": "getDcimConsoleServerPortsIdTrace", "summary": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin", "description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this console server port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimConsoleServerPortsIdTrace" }, "task": true }, { "name": "getDcimDeviceBayTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimDeviceBayTemplates" }, "task": true }, { "name": "postDcimDeviceBayTemplates", "summary": "dcim_device-bay-templates_create", "description": "dcim_device-bay-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimDeviceBayTemplates" }, "task": true }, { "name": "putDcimDeviceBayTemplates", "summary": "dcim_device-bay-templates_bulk_update", "description": "dcim_device-bay-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDeviceBayTemplates" }, "task": true }, { "name": "patchDcimDeviceBayTemplates", "summary": "dcim_device-bay-templates_bulk_partial_update", "description": "dcim_device-bay-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDeviceBayTemplates" }, "task": true }, { "name": "deleteDcimDeviceBayTemplates", "summary": "dcim_device-bay-templates_bulk_delete", "description": "dcim_device-bay-templates_bulk_delete", "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": "/deleteDcimDeviceBayTemplates" }, "task": true }, { "name": "getDcimDeviceBayTemplatesId", "summary": "dcim_device-bay-templates_read", "description": "dcim_device-bay-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device bay template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimDeviceBayTemplatesId" }, "task": true }, { "name": "putDcimDeviceBayTemplatesId", "summary": "dcim_device-bay-templates_update", "description": "dcim_device-bay-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device bay template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDeviceBayTemplatesId" }, "task": true }, { "name": "patchDcimDeviceBayTemplatesId", "summary": "dcim_device-bay-templates_partial_update", "description": "dcim_device-bay-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device bay template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDeviceBayTemplatesId" }, "task": true }, { "name": "deleteDcimDeviceBayTemplatesId", "summary": "dcim_device-bay-templates_delete", "description": "dcim_device-bay-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device bay template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimDeviceBayTemplatesId" }, "task": true }, { "name": "getDcimDeviceBays", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "installed_device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimDeviceBays" }, "task": true }, { "name": "postDcimDeviceBays", "summary": "dcim_device-bays_create", "description": "dcim_device-bays_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"installed_device\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "installed_device": { "title": "Installed device", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimDeviceBays" }, "task": true }, { "name": "putDcimDeviceBays", "summary": "dcim_device-bays_bulk_update", "description": "dcim_device-bays_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"installed_device\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "installed_device": { "title": "Installed device", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDeviceBays" }, "task": true }, { "name": "patchDcimDeviceBays", "summary": "dcim_device-bays_bulk_partial_update", "description": "dcim_device-bays_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"installed_device\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "installed_device": { "title": "Installed device", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDeviceBays" }, "task": true }, { "name": "deleteDcimDeviceBays", "summary": "dcim_device-bays_bulk_delete", "description": "dcim_device-bays_bulk_delete", "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": "/deleteDcimDeviceBays" }, "task": true }, { "name": "getDcimDeviceBaysId", "summary": "dcim_device-bays_read", "description": "dcim_device-bays_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device bay.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimDeviceBaysId" }, "task": true }, { "name": "putDcimDeviceBaysId", "summary": "dcim_device-bays_update", "description": "dcim_device-bays_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device bay.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"installed_device\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "installed_device": { "title": "Installed device", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDeviceBaysId" }, "task": true }, { "name": "patchDcimDeviceBaysId", "summary": "dcim_device-bays_partial_update", "description": "dcim_device-bays_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device bay.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"label\": \"string\", \"description\": \"string\", \"installed_device\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "installed_device": { "title": "Installed device", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDeviceBaysId" }, "task": true }, { "name": "deleteDcimDeviceBaysId", "summary": "dcim_device-bays_delete", "description": "dcim_device-bays_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device bay.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimDeviceBaysId" }, "task": true }, { "name": "getDcimDeviceRoles", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "vmRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "vmRole", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "colorIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIc", "type": "string" } }, { "name": "colorNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNic", "type": "string" } }, { "name": "colorIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIew", "type": "string" } }, { "name": "colorNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNiew", "type": "string" } }, { "name": "colorIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIsw", "type": "string" } }, { "name": "colorNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNisw", "type": "string" } }, { "name": "colorIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIe", "type": "string" } }, { "name": "colorNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "vm_role": { "title": "VM Role", "description": "Virtual machines may be assigned to this role", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimDeviceRoles" }, "task": true }, { "name": "postDcimDeviceRoles", "summary": "dcim_device-roles_create", "description": "dcim_device-roles_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"vm_role\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "vm_role": { "title": "VM Role", "description": "Virtual machines may be assigned to this role", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimDeviceRoles" }, "task": true }, { "name": "putDcimDeviceRoles", "summary": "dcim_device-roles_bulk_update", "description": "dcim_device-roles_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"vm_role\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "vm_role": { "title": "VM Role", "description": "Virtual machines may be assigned to this role", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDeviceRoles" }, "task": true }, { "name": "patchDcimDeviceRoles", "summary": "dcim_device-roles_bulk_partial_update", "description": "dcim_device-roles_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"vm_role\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "vm_role": { "title": "VM Role", "description": "Virtual machines may be assigned to this role", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDeviceRoles" }, "task": true }, { "name": "deleteDcimDeviceRoles", "summary": "dcim_device-roles_bulk_delete", "description": "dcim_device-roles_bulk_delete", "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": "/deleteDcimDeviceRoles" }, "task": true }, { "name": "getDcimDeviceRolesId", "summary": "dcim_device-roles_read", "description": "dcim_device-roles_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device role.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimDeviceRolesId" }, "task": true }, { "name": "putDcimDeviceRolesId", "summary": "dcim_device-roles_update", "description": "dcim_device-roles_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"vm_role\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "vm_role": { "title": "VM Role", "description": "Virtual machines may be assigned to this role", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDeviceRolesId" }, "task": true }, { "name": "patchDcimDeviceRolesId", "summary": "dcim_device-roles_partial_update", "description": "dcim_device-roles_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"vm_role\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "vm_role": { "title": "VM Role", "description": "Virtual machines may be assigned to this role", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDeviceRolesId" }, "task": true }, { "name": "deleteDcimDeviceRolesId", "summary": "dcim_device-roles_delete", "description": "dcim_device-roles_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device role.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimDeviceRolesId" }, "task": true }, { "name": "getDcimDeviceTypes", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "model", "type": "string", "info": ": string", "required": false, "schema": { "title": "model", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "partNumber", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumber", "type": "string" } }, { "name": "uHeight", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeight", "type": "string" } }, { "name": "isFullDepth", "type": "string", "info": ": string", "required": false, "schema": { "title": "isFullDepth", "type": "string" } }, { "name": "subdeviceRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "subdeviceRole", "type": "string" } }, { "name": "airflow", "type": "string", "info": ": string", "required": false, "schema": { "title": "airflow", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "manufacturerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerId", "type": "string" } }, { "name": "manufacturer", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturer", "type": "string" } }, { "name": "hasFrontImage", "type": "string", "info": ": string", "required": false, "schema": { "title": "hasFrontImage", "type": "string" } }, { "name": "hasRearImage", "type": "string", "info": ": string", "required": false, "schema": { "title": "hasRearImage", "type": "string" } }, { "name": "consolePorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "consolePorts", "type": "string" } }, { "name": "consoleServerPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "consoleServerPorts", "type": "string" } }, { "name": "powerPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "powerPorts", "type": "string" } }, { "name": "powerOutlets", "type": "string", "info": ": string", "required": false, "schema": { "title": "powerOutlets", "type": "string" } }, { "name": "interfaces", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaces", "type": "string" } }, { "name": "passThroughPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "passThroughPorts", "type": "string" } }, { "name": "moduleBays", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleBays", "type": "string" } }, { "name": "deviceBays", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceBays", "type": "string" } }, { "name": "inventoryItems", "type": "string", "info": ": string", "required": false, "schema": { "title": "inventoryItems", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "modelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelN", "type": "string" } }, { "name": "modelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelIc", "type": "string" } }, { "name": "modelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelNic", "type": "string" } }, { "name": "modelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelIew", "type": "string" } }, { "name": "modelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelNiew", "type": "string" } }, { "name": "modelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelIsw", "type": "string" } }, { "name": "modelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelNisw", "type": "string" } }, { "name": "modelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelIe", "type": "string" } }, { "name": "modelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "partNumberN", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberN", "type": "string" } }, { "name": "partNumberIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberIc", "type": "string" } }, { "name": "partNumberNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberNic", "type": "string" } }, { "name": "partNumberIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberIew", "type": "string" } }, { "name": "partNumberNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberNiew", "type": "string" } }, { "name": "partNumberIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberIsw", "type": "string" } }, { "name": "partNumberNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberNisw", "type": "string" } }, { "name": "partNumberIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberIe", "type": "string" } }, { "name": "partNumberNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberNie", "type": "string" } }, { "name": "uHeightN", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightN", "type": "string" } }, { "name": "uHeightLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightLte", "type": "string" } }, { "name": "uHeightLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightLt", "type": "string" } }, { "name": "uHeightGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightGte", "type": "string" } }, { "name": "uHeightGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightGt", "type": "string" } }, { "name": "subdeviceRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "subdeviceRoleN", "type": "string" } }, { "name": "airflowN", "type": "string", "info": ": string", "required": false, "schema": { "title": "airflowN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "manufacturerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerIdN", "type": "string" } }, { "name": "manufacturerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "manufacturer", "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "u_height": { "title": "Position (U)", "type": "number", "default": 1, "minimum": 0 }, "is_full_depth": { "title": "Is full depth", "description": "Device consumes both front and rear rack faces", "type": "boolean" }, "subdevice_role": { "title": "Subdevice role", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Parent", "Child" ] }, "value": { "type": "string", "enum": [ "parent", "child" ] } } }, "airflow": { "title": "Airflow", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Front to rear", "Rear to front", "Left to right", "Right to left", "Side to rear", "Passive", "Mixed" ] }, "value": { "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] } } }, "front_image": { "title": "Front image", "type": "string", "readOnly": true }, "rear_image": { "title": "Rear image", "type": "string", "readOnly": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimDeviceTypes" }, "task": true }, { "name": "postDcimDeviceTypes", "summary": "dcim_device-types_create", "description": "dcim_device-types_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"slug\": \"string\", \"part_number\": \"string\", \"u_height\": 123, \"is_full_depth\": \"boolean\", \"subdevice_role\": \"Must be one of [parent, child]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"front_image\": \"string\", \"rear_image\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123}", "required": true, "schema": { "required": [ "manufacturer", "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "u_height": { "title": "Position (U)", "type": "number", "default": 1, "minimum": 0 }, "is_full_depth": { "title": "Is full depth", "description": "Device consumes both front and rear rack faces", "type": "boolean" }, "subdevice_role": { "title": "Parent/child status", "description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.", "type": "string", "enum": [ "parent", "child" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "front_image": { "title": "Front image", "type": "string", "readOnly": true }, "rear_image": { "title": "Rear image", "type": "string", "readOnly": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimDeviceTypes" }, "task": true }, { "name": "putDcimDeviceTypes", "summary": "dcim_device-types_bulk_update", "description": "dcim_device-types_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"slug\": \"string\", \"part_number\": \"string\", \"u_height\": 123, \"is_full_depth\": \"boolean\", \"subdevice_role\": \"Must be one of [parent, child]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"front_image\": \"string\", \"rear_image\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123}", "required": true, "schema": { "required": [ "manufacturer", "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "u_height": { "title": "Position (U)", "type": "number", "default": 1, "minimum": 0 }, "is_full_depth": { "title": "Is full depth", "description": "Device consumes both front and rear rack faces", "type": "boolean" }, "subdevice_role": { "title": "Parent/child status", "description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.", "type": "string", "enum": [ "parent", "child" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "front_image": { "title": "Front image", "type": "string", "readOnly": true }, "rear_image": { "title": "Rear image", "type": "string", "readOnly": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDeviceTypes" }, "task": true }, { "name": "patchDcimDeviceTypes", "summary": "dcim_device-types_bulk_partial_update", "description": "dcim_device-types_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"slug\": \"string\", \"part_number\": \"string\", \"u_height\": 123, \"is_full_depth\": \"boolean\", \"subdevice_role\": \"Must be one of [parent, child]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"front_image\": \"string\", \"rear_image\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123}", "required": true, "schema": { "required": [ "manufacturer", "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "u_height": { "title": "Position (U)", "type": "number", "default": 1, "minimum": 0 }, "is_full_depth": { "title": "Is full depth", "description": "Device consumes both front and rear rack faces", "type": "boolean" }, "subdevice_role": { "title": "Parent/child status", "description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.", "type": "string", "enum": [ "parent", "child" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "front_image": { "title": "Front image", "type": "string", "readOnly": true }, "rear_image": { "title": "Rear image", "type": "string", "readOnly": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDeviceTypes" }, "task": true }, { "name": "deleteDcimDeviceTypes", "summary": "dcim_device-types_bulk_delete", "description": "dcim_device-types_bulk_delete", "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": "/deleteDcimDeviceTypes" }, "task": true }, { "name": "getDcimDeviceTypesId", "summary": "dcim_device-types_read", "description": "dcim_device-types_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device type.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimDeviceTypesId" }, "task": true }, { "name": "putDcimDeviceTypesId", "summary": "dcim_device-types_update", "description": "dcim_device-types_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device type.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"slug\": \"string\", \"part_number\": \"string\", \"u_height\": 123, \"is_full_depth\": \"boolean\", \"subdevice_role\": \"Must be one of [parent, child]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"front_image\": \"string\", \"rear_image\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123}", "required": true, "schema": { "required": [ "manufacturer", "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "u_height": { "title": "Position (U)", "type": "number", "default": 1, "minimum": 0 }, "is_full_depth": { "title": "Is full depth", "description": "Device consumes both front and rear rack faces", "type": "boolean" }, "subdevice_role": { "title": "Parent/child status", "description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.", "type": "string", "enum": [ "parent", "child" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "front_image": { "title": "Front image", "type": "string", "readOnly": true }, "rear_image": { "title": "Rear image", "type": "string", "readOnly": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDeviceTypesId" }, "task": true }, { "name": "patchDcimDeviceTypesId", "summary": "dcim_device-types_partial_update", "description": "dcim_device-types_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device type.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"slug\": \"string\", \"part_number\": \"string\", \"u_height\": 123, \"is_full_depth\": \"boolean\", \"subdevice_role\": \"Must be one of [parent, child]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"front_image\": \"string\", \"rear_image\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123}", "required": true, "schema": { "required": [ "manufacturer", "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "u_height": { "title": "Position (U)", "type": "number", "default": 1, "minimum": 0 }, "is_full_depth": { "title": "Is full depth", "description": "Device consumes both front and rear rack faces", "type": "boolean" }, "subdevice_role": { "title": "Parent/child status", "description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.", "type": "string", "enum": [ "parent", "child" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "front_image": { "title": "Front image", "type": "string", "readOnly": true }, "rear_image": { "title": "Rear image", "type": "string", "readOnly": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDeviceTypesId" }, "task": true }, { "name": "deleteDcimDeviceTypesId", "summary": "dcim_device-types_delete", "description": "dcim_device-types_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device type.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimDeviceTypesId" }, "task": true }, { "name": "getDcimDevices", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "assetTag", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTag", "type": "string" } }, { "name": "face", "type": "string", "info": ": string", "required": false, "schema": { "title": "face", "type": "string" } }, { "name": "position", "type": "string", "info": ": string", "required": false, "schema": { "title": "position", "type": "string" } }, { "name": "airflow", "type": "string", "info": ": string", "required": false, "schema": { "title": "airflow", "type": "string" } }, { "name": "vcPosition", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPosition", "type": "string" } }, { "name": "vcPriority", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPriority", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "localContextData", "type": "string", "info": ": string", "required": false, "schema": { "title": "localContextData", "type": "string" } }, { "name": "manufacturerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerId", "type": "string" } }, { "name": "manufacturer", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturer", "type": "string" } }, { "name": "deviceTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceTypeId", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "parentDeviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentDeviceId", "type": "string" } }, { "name": "platformId", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformId", "type": "string" } }, { "name": "platform", "type": "string", "info": ": string", "required": false, "schema": { "title": "platform", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "clusterId", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterId", "type": "string" } }, { "name": "model", "type": "string", "info": ": string", "required": false, "schema": { "title": "model", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "isFullDepth", "type": "string", "info": ": string", "required": false, "schema": { "title": "isFullDepth", "type": "string" } }, { "name": "macAddress", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddress", "type": "string" } }, { "name": "serial", "type": "string", "info": ": string", "required": false, "schema": { "title": "serial", "type": "string" } }, { "name": "hasPrimaryIp", "type": "string", "info": ": string", "required": false, "schema": { "title": "hasPrimaryIp", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassisMember", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisMember", "type": "string" } }, { "name": "consolePorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "consolePorts", "type": "string" } }, { "name": "consoleServerPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "consoleServerPorts", "type": "string" } }, { "name": "powerPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "powerPorts", "type": "string" } }, { "name": "powerOutlets", "type": "string", "info": ": string", "required": false, "schema": { "title": "powerOutlets", "type": "string" } }, { "name": "interfaces", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaces", "type": "string" } }, { "name": "passThroughPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "passThroughPorts", "type": "string" } }, { "name": "moduleBays", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleBays", "type": "string" } }, { "name": "deviceBays", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceBays", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "assetTagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagN", "type": "string" } }, { "name": "assetTagIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIc", "type": "string" } }, { "name": "assetTagNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNic", "type": "string" } }, { "name": "assetTagIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIew", "type": "string" } }, { "name": "assetTagNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNiew", "type": "string" } }, { "name": "assetTagIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIsw", "type": "string" } }, { "name": "assetTagNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNisw", "type": "string" } }, { "name": "assetTagIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIe", "type": "string" } }, { "name": "assetTagNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNie", "type": "string" } }, { "name": "faceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "faceN", "type": "string" } }, { "name": "positionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionN", "type": "string" } }, { "name": "positionLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionLte", "type": "string" } }, { "name": "positionLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionLt", "type": "string" } }, { "name": "positionGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionGte", "type": "string" } }, { "name": "positionGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionGt", "type": "string" } }, { "name": "airflowN", "type": "string", "info": ": string", "required": false, "schema": { "title": "airflowN", "type": "string" } }, { "name": "vcPositionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPositionN", "type": "string" } }, { "name": "vcPositionLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPositionLte", "type": "string" } }, { "name": "vcPositionLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPositionLt", "type": "string" } }, { "name": "vcPositionGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPositionGte", "type": "string" } }, { "name": "vcPositionGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPositionGt", "type": "string" } }, { "name": "vcPriorityN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPriorityN", "type": "string" } }, { "name": "vcPriorityLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPriorityLte", "type": "string" } }, { "name": "vcPriorityLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPriorityLt", "type": "string" } }, { "name": "vcPriorityGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPriorityGte", "type": "string" } }, { "name": "vcPriorityGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcPriorityGt", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "manufacturerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerIdN", "type": "string" } }, { "name": "manufacturerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerN", "type": "string" } }, { "name": "deviceTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceTypeIdN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "parentDeviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentDeviceIdN", "type": "string" } }, { "name": "platformIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformIdN", "type": "string" } }, { "name": "platformN", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "clusterIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterIdN", "type": "string" } }, { "name": "modelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "macAddressN", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressN", "type": "string" } }, { "name": "macAddressIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIc", "type": "string" } }, { "name": "macAddressNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNic", "type": "string" } }, { "name": "macAddressIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIew", "type": "string" } }, { "name": "macAddressNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNiew", "type": "string" } }, { "name": "macAddressIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIsw", "type": "string" } }, { "name": "macAddressNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNisw", "type": "string" } }, { "name": "macAddressIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIe", "type": "string" } }, { "name": "macAddressNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNie", "type": "string" } }, { "name": "serialN", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialN", "type": "string" } }, { "name": "serialIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIc", "type": "string" } }, { "name": "serialNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNic", "type": "string" } }, { "name": "serialIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIew", "type": "string" } }, { "name": "serialNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNiew", "type": "string" } }, { "name": "serialIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIsw", "type": "string" } }, { "name": "serialNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNisw", "type": "string" } }, { "name": "serialIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIe", "type": "string" } }, { "name": "serialNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNie", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "device_type", "device_role", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "device_role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "platform": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "location": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "rack": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "position": { "title": "Position (U)", "type": "number", "minimum": 0.5, "x-nullable": true }, "face": { "title": "Face", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Front", "Rear" ] }, "value": { "type": "string", "enum": [ "front", "rear" ] } } }, "parent_device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Offline", "Active", "Planned", "Staged", "Failed", "Inventory", "Decommissioning" ] }, "value": { "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "inventory", "decommissioning" ] } } }, "airflow": { "title": "Airflow", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Front to rear", "Rear to front", "Left to right", "Right to left", "Side to rear", "Passive", "Mixed" ] }, "value": { "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] } } }, "primary_ip": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "primary_ip4": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "primary_ip6": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "cluster": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "virtual_chassis": { "required": [ "name", "master" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "master": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "member_count": { "title": "Member count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "vc_position": { "title": "Vc position", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "vc_priority": { "title": "Vc priority", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimDevices" }, "task": true }, { "name": "postDcimDevices", "summary": "dcim_devices_create", "description": "dcim_devices_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device_type\": 123, \"device_role\": 123, \"tenant\": 123, \"platform\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"site\": 123, \"location\": 123, \"rack\": 123, \"position\": 123, \"face\": \"Must be one of [front, rear]\", \"parent_device\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\"}, \"status\": \"Must be one of [offline, active, planned, staged, failed, inventory, decommissioning]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"cluster\": 123, \"virtual_chassis\": 123, \"vc_position\": 123, \"vc_priority\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "device_type", "device_role", "tenant", "site", "rack", "face", "virtual_chassis" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true }, "device_type": { "title": "Device type", "type": "integer" }, "device_role": { "title": "Device role", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "position": { "title": "Position (U)", "type": "number", "minimum": 0.5, "x-nullable": true }, "face": { "title": "Rack face", "type": "string", "enum": [ "front", "rear" ] }, "parent_device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "inventory", "decommissioning" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "virtual_chassis": { "title": "Virtual chassis", "type": "integer", "x-nullable": true }, "vc_position": { "title": "Vc position", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "vc_priority": { "title": "Vc priority", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimDevices" }, "task": true }, { "name": "putDcimDevices", "summary": "dcim_devices_bulk_update", "description": "dcim_devices_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device_type\": 123, \"device_role\": 123, \"tenant\": 123, \"platform\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"site\": 123, \"location\": 123, \"rack\": 123, \"position\": 123, \"face\": \"Must be one of [front, rear]\", \"parent_device\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\"}, \"status\": \"Must be one of [offline, active, planned, staged, failed, inventory, decommissioning]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"cluster\": 123, \"virtual_chassis\": 123, \"vc_position\": 123, \"vc_priority\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "device_type", "device_role", "tenant", "site", "rack", "face", "virtual_chassis" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true }, "device_type": { "title": "Device type", "type": "integer" }, "device_role": { "title": "Device role", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "position": { "title": "Position (U)", "type": "number", "minimum": 0.5, "x-nullable": true }, "face": { "title": "Rack face", "type": "string", "enum": [ "front", "rear" ] }, "parent_device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "inventory", "decommissioning" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "virtual_chassis": { "title": "Virtual chassis", "type": "integer", "x-nullable": true }, "vc_position": { "title": "Vc position", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "vc_priority": { "title": "Vc priority", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDevices" }, "task": true }, { "name": "patchDcimDevices", "summary": "dcim_devices_bulk_partial_update", "description": "dcim_devices_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device_type\": 123, \"device_role\": 123, \"tenant\": 123, \"platform\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"site\": 123, \"location\": 123, \"rack\": 123, \"position\": 123, \"face\": \"Must be one of [front, rear]\", \"parent_device\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\"}, \"status\": \"Must be one of [offline, active, planned, staged, failed, inventory, decommissioning]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"cluster\": 123, \"virtual_chassis\": 123, \"vc_position\": 123, \"vc_priority\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "device_type", "device_role", "tenant", "site", "rack", "face", "virtual_chassis" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true }, "device_type": { "title": "Device type", "type": "integer" }, "device_role": { "title": "Device role", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "position": { "title": "Position (U)", "type": "number", "minimum": 0.5, "x-nullable": true }, "face": { "title": "Rack face", "type": "string", "enum": [ "front", "rear" ] }, "parent_device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "inventory", "decommissioning" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "virtual_chassis": { "title": "Virtual chassis", "type": "integer", "x-nullable": true }, "vc_position": { "title": "Vc position", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "vc_priority": { "title": "Vc priority", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDevices" }, "task": true }, { "name": "deleteDcimDevices", "summary": "dcim_devices_bulk_delete", "description": "dcim_devices_bulk_delete", "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": "/deleteDcimDevices" }, "task": true }, { "name": "getDcimDevicesId", "summary": "dcim_devices_read", "description": "dcim_devices_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimDevicesId" }, "task": true }, { "name": "putDcimDevicesId", "summary": "dcim_devices_update", "description": "dcim_devices_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device_type\": 123, \"device_role\": 123, \"tenant\": 123, \"platform\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"site\": 123, \"location\": 123, \"rack\": 123, \"position\": 123, \"face\": \"Must be one of [front, rear]\", \"parent_device\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\"}, \"status\": \"Must be one of [offline, active, planned, staged, failed, inventory, decommissioning]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"cluster\": 123, \"virtual_chassis\": 123, \"vc_position\": 123, \"vc_priority\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "device_type", "device_role", "tenant", "site", "rack", "face", "virtual_chassis" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true }, "device_type": { "title": "Device type", "type": "integer" }, "device_role": { "title": "Device role", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "position": { "title": "Position (U)", "type": "number", "minimum": 0.5, "x-nullable": true }, "face": { "title": "Rack face", "type": "string", "enum": [ "front", "rear" ] }, "parent_device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "inventory", "decommissioning" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "virtual_chassis": { "title": "Virtual chassis", "type": "integer", "x-nullable": true }, "vc_position": { "title": "Vc position", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "vc_priority": { "title": "Vc priority", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimDevicesId" }, "task": true }, { "name": "patchDcimDevicesId", "summary": "dcim_devices_partial_update", "description": "dcim_devices_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device_type\": 123, \"device_role\": 123, \"tenant\": 123, \"platform\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"site\": 123, \"location\": 123, \"rack\": 123, \"position\": 123, \"face\": \"Must be one of [front, rear]\", \"parent_device\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\"}, \"status\": \"Must be one of [offline, active, planned, staged, failed, inventory, decommissioning]\", \"airflow\": \"Must be one of [front-to-rear, rear-to-front, left-to-right, right-to-left, side-to-rear, passive, mixed]\", \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"cluster\": 123, \"virtual_chassis\": 123, \"vc_position\": 123, \"vc_priority\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "device_type", "device_role", "tenant", "site", "rack", "face", "virtual_chassis" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true }, "device_type": { "title": "Device type", "type": "integer" }, "device_role": { "title": "Device role", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "position": { "title": "Position (U)", "type": "number", "minimum": 0.5, "x-nullable": true }, "face": { "title": "Rack face", "type": "string", "enum": [ "front", "rear" ] }, "parent_device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "inventory", "decommissioning" ] }, "airflow": { "title": "Airflow", "type": "string", "enum": [ "front-to-rear", "rear-to-front", "left-to-right", "right-to-left", "side-to-rear", "passive", "mixed" ] }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "virtual_chassis": { "title": "Virtual chassis", "type": "integer", "x-nullable": true }, "vc_position": { "title": "Vc position", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "vc_priority": { "title": "Vc priority", "type": "integer", "maximum": 255, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimDevicesId" }, "task": true }, { "name": "deleteDcimDevicesId", "summary": "dcim_devices_delete", "description": "dcim_devices_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimDevicesId" }, "task": true }, { "name": "getDcimDevicesIdNapalm", "summary": "Execute a NAPALM method on a Device", "description": "Execute a NAPALM method on a Device", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this device.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "method", "type": "string", "info": ": string", "required": true, "schema": { "title": "method", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimDevicesIdNapalm" }, "task": true }, { "name": "getDcimFrontPortTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "moduletypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "colorIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIc", "type": "string" } }, { "name": "colorNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNic", "type": "string" } }, { "name": "colorIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIew", "type": "string" } }, { "name": "colorNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNiew", "type": "string" } }, { "name": "colorIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIsw", "type": "string" } }, { "name": "colorNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNisw", "type": "string" } }, { "name": "colorIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIe", "type": "string" } }, { "name": "colorNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "moduletypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "8P8C", "8P6C", "8P4C", "8P2C", "6P6C", "6P4C", "6P2C", "4P4C", "4P2C", "GG45", "TERA 4P", "TERA 2P", "TERA 1P", "110 Punch", "BNC", "F Connector", "N Connector", "MRJ21", "FC", "LC", "LC/PC", "LC/UPC", "LC/APC", "LSH", "LSH/PC", "LSH/UPC", "LSH/APC", "MPO", "MTRJ", "SC", "SC/PC", "SC/UPC", "SC/APC", "ST", "CS", "SN", "SMA 905", "SMA 906", "URM-P2", "URM-P4", "URM-P8", "Splice", "Other" ] }, "value": { "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] } } }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 } } }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimFrontPortTemplates" }, "task": true }, { "name": "postDcimFrontPortTemplates", "summary": "dcim_front-port-templates_create", "description": "dcim_front-port-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimFrontPortTemplates" }, "task": true }, { "name": "putDcimFrontPortTemplates", "summary": "dcim_front-port-templates_bulk_update", "description": "dcim_front-port-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimFrontPortTemplates" }, "task": true }, { "name": "patchDcimFrontPortTemplates", "summary": "dcim_front-port-templates_bulk_partial_update", "description": "dcim_front-port-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimFrontPortTemplates" }, "task": true }, { "name": "deleteDcimFrontPortTemplates", "summary": "dcim_front-port-templates_bulk_delete", "description": "dcim_front-port-templates_bulk_delete", "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": "/deleteDcimFrontPortTemplates" }, "task": true }, { "name": "getDcimFrontPortTemplatesId", "summary": "dcim_front-port-templates_read", "description": "dcim_front-port-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimFrontPortTemplatesId" }, "task": true }, { "name": "putDcimFrontPortTemplatesId", "summary": "dcim_front-port-templates_update", "description": "dcim_front-port-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimFrontPortTemplatesId" }, "task": true }, { "name": "patchDcimFrontPortTemplatesId", "summary": "dcim_front-port-templates_partial_update", "description": "dcim_front-port-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimFrontPortTemplatesId" }, "task": true }, { "name": "deleteDcimFrontPortTemplatesId", "summary": "dcim_front-port-templates_delete", "description": "dcim_front-port-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimFrontPortTemplatesId" }, "task": true }, { "name": "getDcimFrontPorts", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "moduleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "colorIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIc", "type": "string" } }, { "name": "colorNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNic", "type": "string" } }, { "name": "colorIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIew", "type": "string" } }, { "name": "colorNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNiew", "type": "string" } }, { "name": "colorIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIsw", "type": "string" } }, { "name": "colorNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNisw", "type": "string" } }, { "name": "colorIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIe", "type": "string" } }, { "name": "colorNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "moduleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleIdN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module": { "required": [ "device" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "8P8C", "8P6C", "8P4C", "8P2C", "6P6C", "6P4C", "6P2C", "4P4C", "4P2C", "GG45", "TERA 4P", "TERA 2P", "TERA 1P", "110 Punch", "BNC", "F Connector", "N Connector", "MRJ21", "FC", "LC", "LC/PC", "LC/UPC", "LC/APC", "LSH", "LSH/PC", "LSH/UPC", "LSH/APC", "MPO", "MTRJ", "SC", "SC/PC", "SC/UPC", "SC/APC", "ST", "CS", "SN", "SMA 905", "SMA 906", "URM-P2", "URM-P4", "URM-P8", "Splice", "Other" ] }, "value": { "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] } } }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 } } }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimFrontPorts" }, "task": true }, { "name": "postDcimFrontPorts", "summary": "dcim_front-ports_create", "description": "dcim_front-ports_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimFrontPorts" }, "task": true }, { "name": "putDcimFrontPorts", "summary": "dcim_front-ports_bulk_update", "description": "dcim_front-ports_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimFrontPorts" }, "task": true }, { "name": "patchDcimFrontPorts", "summary": "dcim_front-ports_bulk_partial_update", "description": "dcim_front-ports_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimFrontPorts" }, "task": true }, { "name": "deleteDcimFrontPorts", "summary": "dcim_front-ports_bulk_delete", "description": "dcim_front-ports_bulk_delete", "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": "/deleteDcimFrontPorts" }, "task": true }, { "name": "getDcimFrontPortsId", "summary": "dcim_front-ports_read", "description": "dcim_front-ports_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimFrontPortsId" }, "task": true }, { "name": "putDcimFrontPortsId", "summary": "dcim_front-ports_update", "description": "dcim_front-ports_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimFrontPortsId" }, "task": true }, { "name": "patchDcimFrontPortsId", "summary": "dcim_front-ports_partial_update", "description": "dcim_front-ports_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"rear_port\": 123, \"rear_port_position\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type", "rear_port" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "rear_port": { "title": "Rear port", "type": "integer" }, "rear_port_position": { "title": "Rear port position", "type": "integer", "default": 1, "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimFrontPortsId" }, "task": true }, { "name": "deleteDcimFrontPortsId", "summary": "dcim_front-ports_delete", "description": "dcim_front-ports_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimFrontPortsId" }, "task": true }, { "name": "getDcimFrontPortsIdPaths", "summary": "Return all CablePaths which traverse a given pass-through port.", "description": "Return all CablePaths which traverse a given pass-through port.", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this front port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimFrontPortsIdPaths" }, "task": true }, { "name": "getDcimInterfaceTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "mgmtOnly", "type": "string", "info": ": string", "required": false, "schema": { "title": "mgmtOnly", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "moduletypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeId", "type": "string" } }, { "name": "poeMode", "type": "string", "info": ": string", "required": false, "schema": { "title": "poeMode", "type": "string" } }, { "name": "poeType", "type": "string", "info": ": string", "required": false, "schema": { "title": "poeType", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "moduletypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeIdN", "type": "string" } }, { "name": "poeModeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "poeModeN", "type": "string" } }, { "name": "poeTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "poeTypeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Virtual", "Bridge", "Link Aggregation Group (LAG)", "100BASE-TX (10/100ME)", "1000BASE-T (1GE)", "2.5GBASE-T (2.5GE)", "5GBASE-T (5GE)", "10GBASE-T (10GE)", "10GBASE-CX4 (10GE)", "GBIC (1GE)", "SFP (1GE)", "SFP+ (10GE)", "XFP (10GE)", "XENPAK (10GE)", "X2 (10GE)", "SFP28 (25GE)", "SFP56 (50GE)", "QSFP+ (40GE)", "QSFP28 (50GE)", "CFP (100GE)", "CFP2 (100GE)", "CFP2 (200GE)", "CFP4 (100GE)", "Cisco CPAK (100GE)", "QSFP28 (100GE)", "QSFP56 (200GE)", "QSFP-DD (400GE)", "OSFP (400GE)", "IEEE 802.11a", "IEEE 802.11b/g", "IEEE 802.11n", "IEEE 802.11ac", "IEEE 802.11ad", "IEEE 802.11ax", "IEEE 802.11ay", "IEEE 802.15.1 (Bluetooth)", "Other (Wireless)", "GSM", "CDMA", "LTE", "OC-3/STM-1", "OC-12/STM-4", "OC-48/STM-16", "OC-192/STM-64", "OC-768/STM-256", "OC-1920/STM-640", "OC-3840/STM-1234", "SFP (1GFC)", "SFP (2GFC)", "SFP (4GFC)", "SFP+ (8GFC)", "SFP+ (16GFC)", "SFP28 (32GFC)", "QSFP+ (64GFC)", "QSFP28 (128GFC)", "SDR (2 Gbps)", "DDR (4 Gbps)", "QDR (8 Gbps)", "FDR10 (10 Gbps)", "FDR (13.5 Gbps)", "EDR (25 Gbps)", "HDR (50 Gbps)", "NDR (100 Gbps)", "XDR (250 Gbps)", "T1 (1.544 Mbps)", "E1 (2.048 Mbps)", "T3 (45 Mbps)", "E3 (34 Mbps)", "xDSL", "DOCSIS", "GPON (2.5 Gbps / 1.25 Gps)", "XG-PON (10 Gbps / 2.5 Gbps)", "XGS-PON (10 Gbps)", "NG-PON2 (TWDM-PON) (4x10 Gbps)", "EPON (1 Gbps)", "10G-EPON (10 Gbps)", "Cisco StackWise", "Cisco StackWise Plus", "Cisco FlexStack", "Cisco FlexStack Plus", "Cisco StackWise-80", "Cisco StackWise-160", "Cisco StackWise-320", "Cisco StackWise-480", "Juniper VCP", "Extreme SummitStack", "Extreme SummitStack-128", "Extreme SummitStack-256", "Extreme SummitStack-512", "Other" ] }, "value": { "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] } } }, "mgmt_only": { "title": "Management only", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "poe_mode": { "title": "Poe mode", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "PD", "PSE" ] }, "value": { "type": "string", "enum": [ "pd", "pse" ] } } }, "poe_type": { "title": "Poe type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "802.3af (Type 1)", "802.3at (Type 2)", "802.3bt (Type 3)", "802.3bt (Type 4)", "Passive 24V (2-pair)", "Passive 24V (4-pair)", "Passive 48V (2-pair)", "Passive 48V (4-pair)" ] }, "value": { "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] } } }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimInterfaceTemplates" }, "task": true }, { "name": "postDcimInterfaceTemplates", "summary": "dcim_interface-templates_create", "description": "dcim_interface-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "mgmt_only": { "title": "Management only", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimInterfaceTemplates" }, "task": true }, { "name": "putDcimInterfaceTemplates", "summary": "dcim_interface-templates_bulk_update", "description": "dcim_interface-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "mgmt_only": { "title": "Management only", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInterfaceTemplates" }, "task": true }, { "name": "patchDcimInterfaceTemplates", "summary": "dcim_interface-templates_bulk_partial_update", "description": "dcim_interface-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "mgmt_only": { "title": "Management only", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInterfaceTemplates" }, "task": true }, { "name": "deleteDcimInterfaceTemplates", "summary": "dcim_interface-templates_bulk_delete", "description": "dcim_interface-templates_bulk_delete", "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": "/deleteDcimInterfaceTemplates" }, "task": true }, { "name": "getDcimInterfaceTemplatesId", "summary": "dcim_interface-templates_read", "description": "dcim_interface-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimInterfaceTemplatesId" }, "task": true }, { "name": "putDcimInterfaceTemplatesId", "summary": "dcim_interface-templates_update", "description": "dcim_interface-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "mgmt_only": { "title": "Management only", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInterfaceTemplatesId" }, "task": true }, { "name": "patchDcimInterfaceTemplatesId", "summary": "dcim_interface-templates_partial_update", "description": "dcim_interface-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "mgmt_only": { "title": "Management only", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInterfaceTemplatesId" }, "task": true }, { "name": "deleteDcimInterfaceTemplatesId", "summary": "dcim_interface-templates_delete", "description": "dcim_interface-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimInterfaceTemplatesId" }, "task": true }, { "name": "getDcimInterfaces", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "enabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "enabled", "type": "string" } }, { "name": "mtu", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtu", "type": "string" } }, { "name": "mgmtOnly", "type": "string", "info": ": string", "required": false, "schema": { "title": "mgmtOnly", "type": "string" } }, { "name": "poeMode", "type": "string", "info": ": string", "required": false, "schema": { "title": "poeMode", "type": "string" } }, { "name": "poeType", "type": "string", "info": ": string", "required": false, "schema": { "title": "poeType", "type": "string" } }, { "name": "mode", "type": "string", "info": ": string", "required": false, "schema": { "title": "mode", "type": "string" } }, { "name": "rfRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfRole", "type": "string" } }, { "name": "rfChannel", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannel", "type": "string" } }, { "name": "rfChannelFrequency", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelFrequency", "type": "string" } }, { "name": "rfChannelWidth", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelWidth", "type": "string" } }, { "name": "txPower", "type": "string", "info": ": string", "required": false, "schema": { "title": "txPower", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "moduleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "connected", "type": "string", "info": ": string", "required": false, "schema": { "title": "connected", "type": "string" } }, { "name": "kind", "type": "string", "info": ": string", "required": false, "schema": { "title": "kind", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "bridgeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "bridgeId", "type": "string" } }, { "name": "lagId", "type": "string", "info": ": string", "required": false, "schema": { "title": "lagId", "type": "string" } }, { "name": "speed", "type": "string", "info": ": string", "required": false, "schema": { "title": "speed", "type": "string" } }, { "name": "duplex", "type": "string", "info": ": string", "required": false, "schema": { "title": "duplex", "type": "string" } }, { "name": "macAddress", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddress", "type": "string" } }, { "name": "wwn", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwn", "type": "string" } }, { "name": "vlanId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlanId", "type": "string" } }, { "name": "vlan", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlan", "type": "string" } }, { "name": "vrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfId", "type": "string" } }, { "name": "vrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrf", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "mtuN", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuN", "type": "string" } }, { "name": "mtuLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuLte", "type": "string" } }, { "name": "mtuLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuLt", "type": "string" } }, { "name": "mtuGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuGte", "type": "string" } }, { "name": "mtuGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuGt", "type": "string" } }, { "name": "poeModeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "poeModeN", "type": "string" } }, { "name": "poeTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "poeTypeN", "type": "string" } }, { "name": "modeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "modeN", "type": "string" } }, { "name": "rfRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfRoleN", "type": "string" } }, { "name": "rfChannelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelN", "type": "string" } }, { "name": "rfChannelFrequencyN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelFrequencyN", "type": "string" } }, { "name": "rfChannelFrequencyLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelFrequencyLte", "type": "string" } }, { "name": "rfChannelFrequencyLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelFrequencyLt", "type": "string" } }, { "name": "rfChannelFrequencyGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelFrequencyGte", "type": "string" } }, { "name": "rfChannelFrequencyGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelFrequencyGt", "type": "string" } }, { "name": "rfChannelWidthN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelWidthN", "type": "string" } }, { "name": "rfChannelWidthLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelWidthLte", "type": "string" } }, { "name": "rfChannelWidthLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelWidthLt", "type": "string" } }, { "name": "rfChannelWidthGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelWidthGte", "type": "string" } }, { "name": "rfChannelWidthGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "rfChannelWidthGt", "type": "string" } }, { "name": "txPowerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "txPowerN", "type": "string" } }, { "name": "txPowerLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "txPowerLte", "type": "string" } }, { "name": "txPowerLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "txPowerLt", "type": "string" } }, { "name": "txPowerGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "txPowerGte", "type": "string" } }, { "name": "txPowerGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "txPowerGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "moduleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleIdN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "bridgeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "bridgeIdN", "type": "string" } }, { "name": "lagIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lagIdN", "type": "string" } }, { "name": "speedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "speedN", "type": "string" } }, { "name": "speedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "speedLte", "type": "string" } }, { "name": "speedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "speedLt", "type": "string" } }, { "name": "speedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "speedGte", "type": "string" } }, { "name": "speedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "speedGt", "type": "string" } }, { "name": "duplexN", "type": "string", "info": ": string", "required": false, "schema": { "title": "duplexN", "type": "string" } }, { "name": "macAddressN", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressN", "type": "string" } }, { "name": "macAddressIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIc", "type": "string" } }, { "name": "macAddressNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNic", "type": "string" } }, { "name": "macAddressIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIew", "type": "string" } }, { "name": "macAddressNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNiew", "type": "string" } }, { "name": "macAddressIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIsw", "type": "string" } }, { "name": "macAddressNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNisw", "type": "string" } }, { "name": "macAddressIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIe", "type": "string" } }, { "name": "macAddressNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNie", "type": "string" } }, { "name": "wwnN", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnN", "type": "string" } }, { "name": "wwnIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnIc", "type": "string" } }, { "name": "wwnNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnNic", "type": "string" } }, { "name": "wwnIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnIew", "type": "string" } }, { "name": "wwnNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnNiew", "type": "string" } }, { "name": "wwnIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnIsw", "type": "string" } }, { "name": "wwnNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnNisw", "type": "string" } }, { "name": "wwnIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnIe", "type": "string" } }, { "name": "wwnNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "wwnNie", "type": "string" } }, { "name": "vrfIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfIdN", "type": "string" } }, { "name": "vrfN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module": { "required": [ "device" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Virtual", "Bridge", "Link Aggregation Group (LAG)", "100BASE-TX (10/100ME)", "1000BASE-T (1GE)", "2.5GBASE-T (2.5GE)", "5GBASE-T (5GE)", "10GBASE-T (10GE)", "10GBASE-CX4 (10GE)", "GBIC (1GE)", "SFP (1GE)", "SFP+ (10GE)", "XFP (10GE)", "XENPAK (10GE)", "X2 (10GE)", "SFP28 (25GE)", "SFP56 (50GE)", "QSFP+ (40GE)", "QSFP28 (50GE)", "CFP (100GE)", "CFP2 (100GE)", "CFP2 (200GE)", "CFP4 (100GE)", "Cisco CPAK (100GE)", "QSFP28 (100GE)", "QSFP56 (200GE)", "QSFP-DD (400GE)", "OSFP (400GE)", "IEEE 802.11a", "IEEE 802.11b/g", "IEEE 802.11n", "IEEE 802.11ac", "IEEE 802.11ad", "IEEE 802.11ax", "IEEE 802.11ay", "IEEE 802.15.1 (Bluetooth)", "Other (Wireless)", "GSM", "CDMA", "LTE", "OC-3/STM-1", "OC-12/STM-4", "OC-48/STM-16", "OC-192/STM-64", "OC-768/STM-256", "OC-1920/STM-640", "OC-3840/STM-1234", "SFP (1GFC)", "SFP (2GFC)", "SFP (4GFC)", "SFP+ (8GFC)", "SFP+ (16GFC)", "SFP28 (32GFC)", "QSFP+ (64GFC)", "QSFP28 (128GFC)", "SDR (2 Gbps)", "DDR (4 Gbps)", "QDR (8 Gbps)", "FDR10 (10 Gbps)", "FDR (13.5 Gbps)", "EDR (25 Gbps)", "HDR (50 Gbps)", "NDR (100 Gbps)", "XDR (250 Gbps)", "T1 (1.544 Mbps)", "E1 (2.048 Mbps)", "T3 (45 Mbps)", "E3 (34 Mbps)", "xDSL", "DOCSIS", "GPON (2.5 Gbps / 1.25 Gps)", "XG-PON (10 Gbps / 2.5 Gbps)", "XGS-PON (10 Gbps)", "NG-PON2 (TWDM-PON) (4x10 Gbps)", "EPON (1 Gbps)", "10G-EPON (10 Gbps)", "Cisco StackWise", "Cisco StackWise Plus", "Cisco FlexStack", "Cisco FlexStack Plus", "Cisco StackWise-80", "Cisco StackWise-160", "Cisco StackWise-320", "Cisco StackWise-480", "Juniper VCP", "Extreme SummitStack", "Extreme SummitStack-128", "Extreme SummitStack-256", "Extreme SummitStack-512", "Other" ] }, "value": { "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] } } }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "cable": { "title": "Cable", "type": "integer", "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "x-nullable": true }, "bridge": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "cable": { "title": "Cable", "type": "integer", "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "x-nullable": true }, "lag": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "cable": { "title": "Cable", "type": "integer", "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "speed": { "title": "Speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "duplex": { "title": "Duplex", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Half", "Full", "Auto" ] }, "value": { "type": "string", "enum": [ "half", "full", "auto" ] } } }, "wwn": { "title": "WWN", "description": "64-bit World Wide Name", "type": "string", "x-nullable": true }, "mgmt_only": { "title": "Management only", "description": "This interface is used only for out-of-band management", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Access", "Tagged", "Tagged (All)" ] }, "value": { "type": "string", "enum": [ "access", "tagged", "tagged-all" ] } } }, "rf_role": { "title": "Rf role", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Access point", "Station" ] }, "value": { "type": "string", "enum": [ "ap", "station" ] } } }, "rf_channel": { "title": "Rf channel", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "1 (2412 MHz)", "2 (2417 MHz)", "3 (2422 MHz)", "4 (2427 MHz)", "5 (2432 MHz)", "6 (2437 MHz)", "7 (2442 MHz)", "8 (2447 MHz)", "9 (2452 MHz)", "10 (2457 MHz)", "11 (2462 MHz)", "12 (2467 MHz)", "13 (2472 MHz)", "32 (5160/20 MHz)", "34 (5170/40 MHz)", "36 (5180/20 MHz)", "38 (5190/40 MHz)", "40 (5200/20 MHz)", "42 (5210/80 MHz)", "44 (5220/20 MHz)", "46 (5230/40 MHz)", "48 (5240/20 MHz)", "50 (5250/160 MHz)", "52 (5260/20 MHz)", "54 (5270/40 MHz)", "56 (5280/20 MHz)", "58 (5290/80 MHz)", "60 (5300/20 MHz)", "62 (5310/40 MHz)", "64 (5320/20 MHz)", "100 (5500/20 MHz)", "102 (5510/40 MHz)", "104 (5520/20 MHz)", "106 (5530/80 MHz)", "108 (5540/20 MHz)", "110 (5550/40 MHz)", "112 (5560/20 MHz)", "114 (5570/160 MHz)", "116 (5580/20 MHz)", "118 (5590/40 MHz)", "120 (5600/20 MHz)", "122 (5610/80 MHz)", "124 (5620/20 MHz)", "126 (5630/40 MHz)", "128 (5640/20 MHz)", "132 (5660/20 MHz)", "134 (5670/40 MHz)", "136 (5680/20 MHz)", "138 (5690/80 MHz)", "140 (5700/20 MHz)", "142 (5710/40 MHz)", "144 (5720/20 MHz)", "149 (5745/20 MHz)", "151 (5755/40 MHz)", "153 (5765/20 MHz)", "155 (5775/80 MHz)", "157 (5785/20 MHz)", "159 (5795/40 MHz)", "161 (5805/20 MHz)", "163 (5815/160 MHz)", "165 (5825/20 MHz)", "167 (5835/40 MHz)", "169 (5845/20 MHz)", "171 (5855/80 MHz)", "173 (5865/20 MHz)", "175 (5875/40 MHz)", "177 (5885/20 MHz)", "1 (5955/20 MHz)", "3 (5965/40 MHz)", "5 (5975/20 MHz)", "7 (5985/80 MHz)", "9 (5995/20 MHz)", "11 (6005/40 MHz)", "13 (6015/20 MHz)", "15 (6025/160 MHz)", "17 (6035/20 MHz)", "19 (6045/40 MHz)", "21 (6055/20 MHz)", "23 (6065/80 MHz)", "25 (6075/20 MHz)", "27 (6085/40 MHz)", "29 (6095/20 MHz)", "31 (6105/320 MHz)", "33 (6115/20 MHz)", "35 (6125/40 MHz)", "37 (6135/20 MHz)", "39 (6145/80 MHz)", "41 (6155/20 MHz)", "43 (6165/40 MHz)", "45 (6175/20 MHz)", "47 (6185/160 MHz)", "49 (6195/20 MHz)", "51 (6205/40 MHz)", "53 (6215/20 MHz)", "55 (6225/80 MHz)", "57 (6235/20 MHz)", "59 (6245/40 MHz)", "61 (6255/20 MHz)", "65 (6275/20 MHz)", "67 (6285/40 MHz)", "69 (6295/20 MHz)", "71 (6305/80 MHz)", "73 (6315/20 MHz)", "75 (6325/40 MHz)", "77 (6335/20 MHz)", "79 (6345/160 MHz)", "81 (6355/20 MHz)", "83 (6365/40 MHz)", "85 (6375/20 MHz)", "87 (6385/80 MHz)", "89 (6395/20 MHz)", "91 (6405/40 MHz)", "93 (6415/20 MHz)", "95 (6425/320 MHz)", "97 (6435/20 MHz)", "99 (6445/40 MHz)", "101 (6455/20 MHz)", "103 (6465/80 MHz)", "105 (6475/20 MHz)", "107 (6485/40 MHz)", "109 (6495/20 MHz)", "111 (6505/160 MHz)", "113 (6515/20 MHz)", "115 (6525/40 MHz)", "117 (6535/20 MHz)", "119 (6545/80 MHz)", "121 (6555/20 MHz)", "123 (6565/40 MHz)", "125 (6575/20 MHz)", "129 (6595/20 MHz)", "131 (6605/40 MHz)", "133 (6615/20 MHz)", "135 (6625/80 MHz)", "137 (6635/20 MHz)", "139 (6645/40 MHz)", "141 (6655/20 MHz)", "143 (6665/160 MHz)", "145 (6675/20 MHz)", "147 (6685/40 MHz)", "149 (6695/20 MHz)", "151 (6705/80 MHz)", "153 (6715/20 MHz)", "155 (6725/40 MHz)", "157 (6735/20 MHz)", "159 (6745/320 MHz)", "161 (6755/20 MHz)", "163 (6765/40 MHz)", "165 (6775/20 MHz)", "167 (6785/80 MHz)", "169 (6795/20 MHz)", "171 (6805/40 MHz)", "173 (6815/20 MHz)", "175 (6825/160 MHz)", "177 (6835/20 MHz)", "179 (6845/40 MHz)", "181 (6855/20 MHz)", "183 (6865/80 MHz)", "185 (6875/20 MHz)", "187 (6885/40 MHz)", "189 (6895/20 MHz)", "193 (6915/20 MHz)", "195 (6925/40 MHz)", "197 (6935/20 MHz)", "199 (6945/80 MHz)", "201 (6955/20 MHz)", "203 (6965/40 MHz)", "205 (6975/20 MHz)", "207 (6985/160 MHz)", "209 (6995/20 MHz)", "211 (7005/40 MHz)", "213 (7015/20 MHz)", "215 (7025/80 MHz)", "217 (7035/20 MHz)", "219 (7045/40 MHz)", "221 (7055/20 MHz)", "225 (7075/20 MHz)", "227 (7085/40 MHz)", "229 (7095/20 MHz)", "233 (7115/20 MHz)", "1 (58.32/2.16 GHz)", "2 (60.48/2.16 GHz)", "3 (62.64/2.16 GHz)", "4 (64.80/2.16 GHz)", "5 (66.96/2.16 GHz)", "6 (69.12/2.16 GHz)", "9 (59.40/4.32 GHz)", "10 (61.56/4.32 GHz)", "11 (63.72/4.32 GHz)", "12 (65.88/4.32 GHz)", "13 (68.04/4.32 GHz)", "17 (60.48/6.48 GHz)", "18 (62.64/6.48 GHz)", "19 (64.80/6.48 GHz)", "20 (66.96/6.48 GHz)", "25 (61.56/8.64 GHz)", "26 (63.72/8.64 GHz)", "27 (65.88/8.64 GHz)" ] }, "value": { "type": "string", "enum": [ "2.4g-1-2412-22", "2.4g-2-2417-22", "2.4g-3-2422-22", "2.4g-4-2427-22", "2.4g-5-2432-22", "2.4g-6-2437-22", "2.4g-7-2442-22", "2.4g-8-2447-22", "2.4g-9-2452-22", "2.4g-10-2457-22", "2.4g-11-2462-22", "2.4g-12-2467-22", "2.4g-13-2472-22", "5g-32-5160-20", "5g-34-5170-40", "5g-36-5180-20", "5g-38-5190-40", "5g-40-5200-20", "5g-42-5210-80", "5g-44-5220-20", "5g-46-5230-40", "5g-48-5240-20", "5g-50-5250-160", "5g-52-5260-20", "5g-54-5270-40", "5g-56-5280-20", "5g-58-5290-80", "5g-60-5300-20", "5g-62-5310-40", "5g-64-5320-20", "5g-100-5500-20", "5g-102-5510-40", "5g-104-5520-20", "5g-106-5530-80", "5g-108-5540-20", "5g-110-5550-40", "5g-112-5560-20", "5g-114-5570-160", "5g-116-5580-20", "5g-118-5590-40", "5g-120-5600-20", "5g-122-5610-80", "5g-124-5620-20", "5g-126-5630-40", "5g-128-5640-20", "5g-132-5660-20", "5g-134-5670-40", "5g-136-5680-20", "5g-138-5690-80", "5g-140-5700-20", "5g-142-5710-40", "5g-144-5720-20", "5g-149-5745-20", "5g-151-5755-40", "5g-153-5765-20", "5g-155-5775-80", "5g-157-5785-20", "5g-159-5795-40", "5g-161-5805-20", "5g-163-5815-160", "5g-165-5825-20", "5g-167-5835-40", "5g-169-5845-20", "5g-171-5855-80", "5g-173-5865-20", "5g-175-5875-40", "5g-177-5885-20", "6g-1-5955-20", "6g-3-5965-40", "6g-5-5975-20", "6g-7-5985-80", "6g-9-5995-20", "6g-11-6005-40", "6g-13-6015-20", "6g-15-6025-160", "6g-17-6035-20", "6g-19-6045-40", "6g-21-6055-20", "6g-23-6065-80", "6g-25-6075-20", "6g-27-6085-40", "6g-29-6095-20", "6g-31-6105-320", "6g-33-6115-20", "6g-35-6125-40", "6g-37-6135-20", "6g-39-6145-80", "6g-41-6155-20", "6g-43-6165-40", "6g-45-6175-20", "6g-47-6185-160", "6g-49-6195-20", "6g-51-6205-40", "6g-53-6215-20", "6g-55-6225-80", "6g-57-6235-20", "6g-59-6245-40", "6g-61-6255-20", "6g-65-6275-20", "6g-67-6285-40", "6g-69-6295-20", "6g-71-6305-80", "6g-73-6315-20", "6g-75-6325-40", "6g-77-6335-20", "6g-79-6345-160", "6g-81-6355-20", "6g-83-6365-40", "6g-85-6375-20", "6g-87-6385-80", "6g-89-6395-20", "6g-91-6405-40", "6g-93-6415-20", "6g-95-6425-320", "6g-97-6435-20", "6g-99-6445-40", "6g-101-6455-20", "6g-103-6465-80", "6g-105-6475-20", "6g-107-6485-40", "6g-109-6495-20", "6g-111-6505-160", "6g-113-6515-20", "6g-115-6525-40", "6g-117-6535-20", "6g-119-6545-80", "6g-121-6555-20", "6g-123-6565-40", "6g-125-6575-20", "6g-129-6595-20", "6g-131-6605-40", "6g-133-6615-20", "6g-135-6625-80", "6g-137-6635-20", "6g-139-6645-40", "6g-141-6655-20", "6g-143-6665-160", "6g-145-6675-20", "6g-147-6685-40", "6g-149-6695-20", "6g-151-6705-80", "6g-153-6715-20", "6g-155-6725-40", "6g-157-6735-20", "6g-159-6745-320", "6g-161-6755-20", "6g-163-6765-40", "6g-165-6775-20", "6g-167-6785-80", "6g-169-6795-20", "6g-171-6805-40", "6g-173-6815-20", "6g-175-6825-160", "6g-177-6835-20", "6g-179-6845-40", "6g-181-6855-20", "6g-183-6865-80", "6g-185-6875-20", "6g-187-6885-40", "6g-189-6895-20", "6g-193-6915-20", "6g-195-6925-40", "6g-197-6935-20", "6g-199-6945-80", "6g-201-6955-20", "6g-203-6965-40", "6g-205-6975-20", "6g-207-6985-160", "6g-209-6995-20", "6g-211-7005-40", "6g-213-7015-20", "6g-215-7025-80", "6g-217-7035-20", "6g-219-7045-40", "6g-221-7055-20", "6g-225-7075-20", "6g-227-7085-40", "6g-229-7095-20", "6g-233-7115-20", "60g-1-58320-2160", "60g-2-60480-2160", "60g-3-62640-2160", "60g-4-64800-2160", "60g-5-66960-2160", "60g-6-69120-2160", "60g-9-59400-4320", "60g-10-61560-4320", "60g-11-63720-4320", "60g-12-65880-4320", "60g-13-68040-4320", "60g-17-60480-6480", "60g-18-62640-6480", "60g-19-64800-6480", "60g-20-66960-6480", "60g-25-61560-6480", "60g-26-63720-6480", "60g-27-65880-6480" ] } } }, "poe_mode": { "title": "Poe mode", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "PD", "PSE" ] }, "value": { "type": "string", "enum": [ "pd", "pse" ] } } }, "poe_type": { "title": "Poe type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "802.3af (Type 1)", "802.3at (Type 2)", "802.3bt (Type 3)", "802.3bt (Type 4)", "Passive 24V (2-pair)", "Passive 24V (4-pair)", "Passive 48V (2-pair)", "Passive 48V (4-pair)" ] }, "value": { "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] } } }, "rf_channel_frequency": { "title": "Channel frequency (MHz)", "type": "number", "x-nullable": true }, "rf_channel_width": { "title": "Channel width (MHz)", "type": "number", "x-nullable": true }, "tx_power": { "title": "Transmit power (dBm)", "type": "integer", "maximum": 127, "minimum": 0, "x-nullable": true }, "untagged_vlan": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "uniqueItems": true }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "wireless_link": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32 } } }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "wireless_lans": { "type": "array", "items": { "required": [ "ssid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32, "minLength": 1 } } }, "uniqueItems": true }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "l2vpn_termination": { "required": [ "l2vpn" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] } } } } }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimInterfaces" }, "task": true }, { "name": "postDcimInterfaces", "summary": "dcim_interfaces_create", "description": "dcim_interfaces_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"lag\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"speed\": 123, \"duplex\": \"Must be one of [half, full, auto]\", \"wwn\": \"string\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"rf_role\": \"Must be one of [ap, station]\", \"rf_channel\": \"Must be one of [2.4g-1-2412-22, 2.4g-2-2417-22, 2.4g-3-2422-22, 2.4g-4-2427-22, 2.4g-5-2432-22, 2.4g-6-2437-22, 2.4g-7-2442-22, 2.4g-8-2447-22, 2.4g-9-2452-22, 2.4g-10-2457-22, 2.4g-11-2462-22, 2.4g-12-2467-22, 2.4g-13-2472-22, 5g-32-5160-20, 5g-34-5170-40, 5g-36-5180-20, 5g-38-5190-40, 5g-40-5200-20, 5g-42-5210-80, 5g-44-5220-20, 5g-46-5230-40, 5g-48-5240-20, 5g-50-5250-160, 5g-52-5260-20, 5g-54-5270-40, 5g-56-5280-20, 5g-58-5290-80, 5g-60-5300-20, 5g-62-5310-40, 5g-64-5320-20, 5g-100-5500-20, 5g-102-5510-40, 5g-104-5520-20, 5g-106-5530-80, 5g-108-5540-20, 5g-110-5550-40, 5g-112-5560-20, 5g-114-5570-160, 5g-116-5580-20, 5g-118-5590-40, 5g-120-5600-20, 5g-122-5610-80, 5g-124-5620-20, 5g-126-5630-40, 5g-128-5640-20, 5g-132-5660-20, 5g-134-5670-40, 5g-136-5680-20, 5g-138-5690-80, 5g-140-5700-20, 5g-142-5710-40, 5g-144-5720-20, 5g-149-5745-20, 5g-151-5755-40, 5g-153-5765-20, 5g-155-5775-80, 5g-157-5785-20, 5g-159-5795-40, 5g-161-5805-20, 5g-163-5815-160, 5g-165-5825-20, 5g-167-5835-40, 5g-169-5845-20, 5g-171-5855-80, 5g-173-5865-20, 5g-175-5875-40, 5g-177-5885-20, 6g-1-5955-20, 6g-3-5965-40, 6g-5-5975-20, 6g-7-5985-80, 6g-9-5995-20, 6g-11-6005-40, 6g-13-6015-20, 6g-15-6025-160, 6g-17-6035-20, 6g-19-6045-40, 6g-21-6055-20, 6g-23-6065-80, 6g-25-6075-20, 6g-27-6085-40, 6g-29-6095-20, 6g-31-6105-320, 6g-33-6115-20, 6g-35-6125-40, 6g-37-6135-20, 6g-39-6145-80, 6g-41-6155-20, 6g-43-6165-40, 6g-45-6175-20, 6g-47-6185-160, 6g-49-6195-20, 6g-51-6205-40, 6g-53-6215-20, 6g-55-6225-80, 6g-57-6235-20, 6g-59-6245-40, 6g-61-6255-20, 6g-65-6275-20, 6g-67-6285-40, 6g-69-6295-20, 6g-71-6305-80, 6g-73-6315-20, 6g-75-6325-40, 6g-77-6335-20, 6g-79-6345-160, 6g-81-6355-20, 6g-83-6365-40, 6g-85-6375-20, 6g-87-6385-80, 6g-89-6395-20, 6g-91-6405-40, 6g-93-6415-20, 6g-95-6425-320, 6g-97-6435-20, 6g-99-6445-40, 6g-101-6455-20, 6g-103-6465-80, 6g-105-6475-20, 6g-107-6485-40, 6g-109-6495-20, 6g-111-6505-160, 6g-113-6515-20, 6g-115-6525-40, 6g-117-6535-20, 6g-119-6545-80, 6g-121-6555-20, 6g-123-6565-40, 6g-125-6575-20, 6g-129-6595-20, 6g-131-6605-40, 6g-133-6615-20, 6g-135-6625-80, 6g-137-6635-20, 6g-139-6645-40, 6g-141-6655-20, 6g-143-6665-160, 6g-145-6675-20, 6g-147-6685-40, 6g-149-6695-20, 6g-151-6705-80, 6g-153-6715-20, 6g-155-6725-40, 6g-157-6735-20, 6g-159-6745-320, 6g-161-6755-20, 6g-163-6765-40, 6g-165-6775-20, 6g-167-6785-80, 6g-169-6795-20, 6g-171-6805-40, 6g-173-6815-20, 6g-175-6825-160, 6g-177-6835-20, 6g-179-6845-40, 6g-181-6855-20, 6g-183-6865-80, 6g-185-6875-20, 6g-187-6885-40, 6g-189-6895-20, 6g-193-6915-20, 6g-195-6925-40, 6g-197-6935-20, 6g-199-6945-80, 6g-201-6955-20, 6g-203-6965-40, 6g-205-6975-20, 6g-207-6985-160, 6g-209-6995-20, 6g-211-7005-40, 6g-213-7015-20, 6g-215-7025-80, 6g-217-7035-20, 6g-219-7045-40, 6g-221-7055-20, 6g-225-7075-20, 6g-227-7085-40, 6g-229-7095-20, 6g-233-7115-20, 60g-1-58320-2160, 60g-2-60480-2160, 60g-3-62640-2160, 60g-4-64800-2160, 60g-5-66960-2160, 60g-6-69120-2160, 60g-9-59400-4320, 60g-10-61560-4320, 60g-11-63720-4320, 60g-12-65880-4320, 60g-13-68040-4320, 60g-17-60480-6480, 60g-18-62640-6480, 60g-19-64800-6480, 60g-20-66960-6480, 60g-25-61560-6480, 60g-26-63720-6480, 60g-27-65880-6480]\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"rf_channel_frequency\": 123, \"rf_channel_width\": 123, \"tx_power\": 123, \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"wireless_link\": 123, \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"wireless_lans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123, \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "lag": { "title": "Parent LAG", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "speed": { "title": "Speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "duplex": { "title": "Duplex", "type": "string", "enum": [ "half", "full", "auto" ], "x-nullable": true }, "wwn": { "title": "WWN", "description": "64-bit World Wide Name", "type": "string", "x-nullable": true }, "mgmt_only": { "title": "Management only", "description": "This interface is used only for out-of-band management", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "rf_role": { "title": "Wireless role", "type": "string", "enum": [ "ap", "station" ] }, "rf_channel": { "title": "Wireless channel", "type": "string", "enum": [ "2.4g-1-2412-22", "2.4g-2-2417-22", "2.4g-3-2422-22", "2.4g-4-2427-22", "2.4g-5-2432-22", "2.4g-6-2437-22", "2.4g-7-2442-22", "2.4g-8-2447-22", "2.4g-9-2452-22", "2.4g-10-2457-22", "2.4g-11-2462-22", "2.4g-12-2467-22", "2.4g-13-2472-22", "5g-32-5160-20", "5g-34-5170-40", "5g-36-5180-20", "5g-38-5190-40", "5g-40-5200-20", "5g-42-5210-80", "5g-44-5220-20", "5g-46-5230-40", "5g-48-5240-20", "5g-50-5250-160", "5g-52-5260-20", "5g-54-5270-40", "5g-56-5280-20", "5g-58-5290-80", "5g-60-5300-20", "5g-62-5310-40", "5g-64-5320-20", "5g-100-5500-20", "5g-102-5510-40", "5g-104-5520-20", "5g-106-5530-80", "5g-108-5540-20", "5g-110-5550-40", "5g-112-5560-20", "5g-114-5570-160", "5g-116-5580-20", "5g-118-5590-40", "5g-120-5600-20", "5g-122-5610-80", "5g-124-5620-20", "5g-126-5630-40", "5g-128-5640-20", "5g-132-5660-20", "5g-134-5670-40", "5g-136-5680-20", "5g-138-5690-80", "5g-140-5700-20", "5g-142-5710-40", "5g-144-5720-20", "5g-149-5745-20", "5g-151-5755-40", "5g-153-5765-20", "5g-155-5775-80", "5g-157-5785-20", "5g-159-5795-40", "5g-161-5805-20", "5g-163-5815-160", "5g-165-5825-20", "5g-167-5835-40", "5g-169-5845-20", "5g-171-5855-80", "5g-173-5865-20", "5g-175-5875-40", "5g-177-5885-20", "6g-1-5955-20", "6g-3-5965-40", "6g-5-5975-20", "6g-7-5985-80", "6g-9-5995-20", "6g-11-6005-40", "6g-13-6015-20", "6g-15-6025-160", "6g-17-6035-20", "6g-19-6045-40", "6g-21-6055-20", "6g-23-6065-80", "6g-25-6075-20", "6g-27-6085-40", "6g-29-6095-20", "6g-31-6105-320", "6g-33-6115-20", "6g-35-6125-40", "6g-37-6135-20", "6g-39-6145-80", "6g-41-6155-20", "6g-43-6165-40", "6g-45-6175-20", "6g-47-6185-160", "6g-49-6195-20", "6g-51-6205-40", "6g-53-6215-20", "6g-55-6225-80", "6g-57-6235-20", "6g-59-6245-40", "6g-61-6255-20", "6g-65-6275-20", "6g-67-6285-40", "6g-69-6295-20", "6g-71-6305-80", "6g-73-6315-20", "6g-75-6325-40", "6g-77-6335-20", "6g-79-6345-160", "6g-81-6355-20", "6g-83-6365-40", "6g-85-6375-20", "6g-87-6385-80", "6g-89-6395-20", "6g-91-6405-40", "6g-93-6415-20", "6g-95-6425-320", "6g-97-6435-20", "6g-99-6445-40", "6g-101-6455-20", "6g-103-6465-80", "6g-105-6475-20", "6g-107-6485-40", "6g-109-6495-20", "6g-111-6505-160", "6g-113-6515-20", "6g-115-6525-40", "6g-117-6535-20", "6g-119-6545-80", "6g-121-6555-20", "6g-123-6565-40", "6g-125-6575-20", "6g-129-6595-20", "6g-131-6605-40", "6g-133-6615-20", "6g-135-6625-80", "6g-137-6635-20", "6g-139-6645-40", "6g-141-6655-20", "6g-143-6665-160", "6g-145-6675-20", "6g-147-6685-40", "6g-149-6695-20", "6g-151-6705-80", "6g-153-6715-20", "6g-155-6725-40", "6g-157-6735-20", "6g-159-6745-320", "6g-161-6755-20", "6g-163-6765-40", "6g-165-6775-20", "6g-167-6785-80", "6g-169-6795-20", "6g-171-6805-40", "6g-173-6815-20", "6g-175-6825-160", "6g-177-6835-20", "6g-179-6845-40", "6g-181-6855-20", "6g-183-6865-80", "6g-185-6875-20", "6g-187-6885-40", "6g-189-6895-20", "6g-193-6915-20", "6g-195-6925-40", "6g-197-6935-20", "6g-199-6945-80", "6g-201-6955-20", "6g-203-6965-40", "6g-205-6975-20", "6g-207-6985-160", "6g-209-6995-20", "6g-211-7005-40", "6g-213-7015-20", "6g-215-7025-80", "6g-217-7035-20", "6g-219-7045-40", "6g-221-7055-20", "6g-225-7075-20", "6g-227-7085-40", "6g-229-7095-20", "6g-233-7115-20", "60g-1-58320-2160", "60g-2-60480-2160", "60g-3-62640-2160", "60g-4-64800-2160", "60g-5-66960-2160", "60g-6-69120-2160", "60g-9-59400-4320", "60g-10-61560-4320", "60g-11-63720-4320", "60g-12-65880-4320", "60g-13-68040-4320", "60g-17-60480-6480", "60g-18-62640-6480", "60g-19-64800-6480", "60g-20-66960-6480", "60g-25-61560-6480", "60g-26-63720-6480", "60g-27-65880-6480" ] }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "rf_channel_frequency": { "title": "Channel frequency (MHz)", "type": "number", "x-nullable": true }, "rf_channel_width": { "title": "Channel width (MHz)", "type": "number", "x-nullable": true }, "tx_power": { "title": "Transmit power (dBm)", "type": "integer", "maximum": 127, "minimum": 0, "x-nullable": true }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "wireless_link": { "title": "Wireless link", "type": "integer", "x-nullable": true }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "wireless_lans": { "type": "array", "items": { "title": "Wireless LANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimInterfaces" }, "task": true }, { "name": "putDcimInterfaces", "summary": "dcim_interfaces_bulk_update", "description": "dcim_interfaces_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"lag\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"speed\": 123, \"duplex\": \"Must be one of [half, full, auto]\", \"wwn\": \"string\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"rf_role\": \"Must be one of [ap, station]\", \"rf_channel\": \"Must be one of [2.4g-1-2412-22, 2.4g-2-2417-22, 2.4g-3-2422-22, 2.4g-4-2427-22, 2.4g-5-2432-22, 2.4g-6-2437-22, 2.4g-7-2442-22, 2.4g-8-2447-22, 2.4g-9-2452-22, 2.4g-10-2457-22, 2.4g-11-2462-22, 2.4g-12-2467-22, 2.4g-13-2472-22, 5g-32-5160-20, 5g-34-5170-40, 5g-36-5180-20, 5g-38-5190-40, 5g-40-5200-20, 5g-42-5210-80, 5g-44-5220-20, 5g-46-5230-40, 5g-48-5240-20, 5g-50-5250-160, 5g-52-5260-20, 5g-54-5270-40, 5g-56-5280-20, 5g-58-5290-80, 5g-60-5300-20, 5g-62-5310-40, 5g-64-5320-20, 5g-100-5500-20, 5g-102-5510-40, 5g-104-5520-20, 5g-106-5530-80, 5g-108-5540-20, 5g-110-5550-40, 5g-112-5560-20, 5g-114-5570-160, 5g-116-5580-20, 5g-118-5590-40, 5g-120-5600-20, 5g-122-5610-80, 5g-124-5620-20, 5g-126-5630-40, 5g-128-5640-20, 5g-132-5660-20, 5g-134-5670-40, 5g-136-5680-20, 5g-138-5690-80, 5g-140-5700-20, 5g-142-5710-40, 5g-144-5720-20, 5g-149-5745-20, 5g-151-5755-40, 5g-153-5765-20, 5g-155-5775-80, 5g-157-5785-20, 5g-159-5795-40, 5g-161-5805-20, 5g-163-5815-160, 5g-165-5825-20, 5g-167-5835-40, 5g-169-5845-20, 5g-171-5855-80, 5g-173-5865-20, 5g-175-5875-40, 5g-177-5885-20, 6g-1-5955-20, 6g-3-5965-40, 6g-5-5975-20, 6g-7-5985-80, 6g-9-5995-20, 6g-11-6005-40, 6g-13-6015-20, 6g-15-6025-160, 6g-17-6035-20, 6g-19-6045-40, 6g-21-6055-20, 6g-23-6065-80, 6g-25-6075-20, 6g-27-6085-40, 6g-29-6095-20, 6g-31-6105-320, 6g-33-6115-20, 6g-35-6125-40, 6g-37-6135-20, 6g-39-6145-80, 6g-41-6155-20, 6g-43-6165-40, 6g-45-6175-20, 6g-47-6185-160, 6g-49-6195-20, 6g-51-6205-40, 6g-53-6215-20, 6g-55-6225-80, 6g-57-6235-20, 6g-59-6245-40, 6g-61-6255-20, 6g-65-6275-20, 6g-67-6285-40, 6g-69-6295-20, 6g-71-6305-80, 6g-73-6315-20, 6g-75-6325-40, 6g-77-6335-20, 6g-79-6345-160, 6g-81-6355-20, 6g-83-6365-40, 6g-85-6375-20, 6g-87-6385-80, 6g-89-6395-20, 6g-91-6405-40, 6g-93-6415-20, 6g-95-6425-320, 6g-97-6435-20, 6g-99-6445-40, 6g-101-6455-20, 6g-103-6465-80, 6g-105-6475-20, 6g-107-6485-40, 6g-109-6495-20, 6g-111-6505-160, 6g-113-6515-20, 6g-115-6525-40, 6g-117-6535-20, 6g-119-6545-80, 6g-121-6555-20, 6g-123-6565-40, 6g-125-6575-20, 6g-129-6595-20, 6g-131-6605-40, 6g-133-6615-20, 6g-135-6625-80, 6g-137-6635-20, 6g-139-6645-40, 6g-141-6655-20, 6g-143-6665-160, 6g-145-6675-20, 6g-147-6685-40, 6g-149-6695-20, 6g-151-6705-80, 6g-153-6715-20, 6g-155-6725-40, 6g-157-6735-20, 6g-159-6745-320, 6g-161-6755-20, 6g-163-6765-40, 6g-165-6775-20, 6g-167-6785-80, 6g-169-6795-20, 6g-171-6805-40, 6g-173-6815-20, 6g-175-6825-160, 6g-177-6835-20, 6g-179-6845-40, 6g-181-6855-20, 6g-183-6865-80, 6g-185-6875-20, 6g-187-6885-40, 6g-189-6895-20, 6g-193-6915-20, 6g-195-6925-40, 6g-197-6935-20, 6g-199-6945-80, 6g-201-6955-20, 6g-203-6965-40, 6g-205-6975-20, 6g-207-6985-160, 6g-209-6995-20, 6g-211-7005-40, 6g-213-7015-20, 6g-215-7025-80, 6g-217-7035-20, 6g-219-7045-40, 6g-221-7055-20, 6g-225-7075-20, 6g-227-7085-40, 6g-229-7095-20, 6g-233-7115-20, 60g-1-58320-2160, 60g-2-60480-2160, 60g-3-62640-2160, 60g-4-64800-2160, 60g-5-66960-2160, 60g-6-69120-2160, 60g-9-59400-4320, 60g-10-61560-4320, 60g-11-63720-4320, 60g-12-65880-4320, 60g-13-68040-4320, 60g-17-60480-6480, 60g-18-62640-6480, 60g-19-64800-6480, 60g-20-66960-6480, 60g-25-61560-6480, 60g-26-63720-6480, 60g-27-65880-6480]\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"rf_channel_frequency\": 123, \"rf_channel_width\": 123, \"tx_power\": 123, \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"wireless_link\": 123, \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"wireless_lans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123, \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "lag": { "title": "Parent LAG", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "speed": { "title": "Speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "duplex": { "title": "Duplex", "type": "string", "enum": [ "half", "full", "auto" ], "x-nullable": true }, "wwn": { "title": "WWN", "description": "64-bit World Wide Name", "type": "string", "x-nullable": true }, "mgmt_only": { "title": "Management only", "description": "This interface is used only for out-of-band management", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "rf_role": { "title": "Wireless role", "type": "string", "enum": [ "ap", "station" ] }, "rf_channel": { "title": "Wireless channel", "type": "string", "enum": [ "2.4g-1-2412-22", "2.4g-2-2417-22", "2.4g-3-2422-22", "2.4g-4-2427-22", "2.4g-5-2432-22", "2.4g-6-2437-22", "2.4g-7-2442-22", "2.4g-8-2447-22", "2.4g-9-2452-22", "2.4g-10-2457-22", "2.4g-11-2462-22", "2.4g-12-2467-22", "2.4g-13-2472-22", "5g-32-5160-20", "5g-34-5170-40", "5g-36-5180-20", "5g-38-5190-40", "5g-40-5200-20", "5g-42-5210-80", "5g-44-5220-20", "5g-46-5230-40", "5g-48-5240-20", "5g-50-5250-160", "5g-52-5260-20", "5g-54-5270-40", "5g-56-5280-20", "5g-58-5290-80", "5g-60-5300-20", "5g-62-5310-40", "5g-64-5320-20", "5g-100-5500-20", "5g-102-5510-40", "5g-104-5520-20", "5g-106-5530-80", "5g-108-5540-20", "5g-110-5550-40", "5g-112-5560-20", "5g-114-5570-160", "5g-116-5580-20", "5g-118-5590-40", "5g-120-5600-20", "5g-122-5610-80", "5g-124-5620-20", "5g-126-5630-40", "5g-128-5640-20", "5g-132-5660-20", "5g-134-5670-40", "5g-136-5680-20", "5g-138-5690-80", "5g-140-5700-20", "5g-142-5710-40", "5g-144-5720-20", "5g-149-5745-20", "5g-151-5755-40", "5g-153-5765-20", "5g-155-5775-80", "5g-157-5785-20", "5g-159-5795-40", "5g-161-5805-20", "5g-163-5815-160", "5g-165-5825-20", "5g-167-5835-40", "5g-169-5845-20", "5g-171-5855-80", "5g-173-5865-20", "5g-175-5875-40", "5g-177-5885-20", "6g-1-5955-20", "6g-3-5965-40", "6g-5-5975-20", "6g-7-5985-80", "6g-9-5995-20", "6g-11-6005-40", "6g-13-6015-20", "6g-15-6025-160", "6g-17-6035-20", "6g-19-6045-40", "6g-21-6055-20", "6g-23-6065-80", "6g-25-6075-20", "6g-27-6085-40", "6g-29-6095-20", "6g-31-6105-320", "6g-33-6115-20", "6g-35-6125-40", "6g-37-6135-20", "6g-39-6145-80", "6g-41-6155-20", "6g-43-6165-40", "6g-45-6175-20", "6g-47-6185-160", "6g-49-6195-20", "6g-51-6205-40", "6g-53-6215-20", "6g-55-6225-80", "6g-57-6235-20", "6g-59-6245-40", "6g-61-6255-20", "6g-65-6275-20", "6g-67-6285-40", "6g-69-6295-20", "6g-71-6305-80", "6g-73-6315-20", "6g-75-6325-40", "6g-77-6335-20", "6g-79-6345-160", "6g-81-6355-20", "6g-83-6365-40", "6g-85-6375-20", "6g-87-6385-80", "6g-89-6395-20", "6g-91-6405-40", "6g-93-6415-20", "6g-95-6425-320", "6g-97-6435-20", "6g-99-6445-40", "6g-101-6455-20", "6g-103-6465-80", "6g-105-6475-20", "6g-107-6485-40", "6g-109-6495-20", "6g-111-6505-160", "6g-113-6515-20", "6g-115-6525-40", "6g-117-6535-20", "6g-119-6545-80", "6g-121-6555-20", "6g-123-6565-40", "6g-125-6575-20", "6g-129-6595-20", "6g-131-6605-40", "6g-133-6615-20", "6g-135-6625-80", "6g-137-6635-20", "6g-139-6645-40", "6g-141-6655-20", "6g-143-6665-160", "6g-145-6675-20", "6g-147-6685-40", "6g-149-6695-20", "6g-151-6705-80", "6g-153-6715-20", "6g-155-6725-40", "6g-157-6735-20", "6g-159-6745-320", "6g-161-6755-20", "6g-163-6765-40", "6g-165-6775-20", "6g-167-6785-80", "6g-169-6795-20", "6g-171-6805-40", "6g-173-6815-20", "6g-175-6825-160", "6g-177-6835-20", "6g-179-6845-40", "6g-181-6855-20", "6g-183-6865-80", "6g-185-6875-20", "6g-187-6885-40", "6g-189-6895-20", "6g-193-6915-20", "6g-195-6925-40", "6g-197-6935-20", "6g-199-6945-80", "6g-201-6955-20", "6g-203-6965-40", "6g-205-6975-20", "6g-207-6985-160", "6g-209-6995-20", "6g-211-7005-40", "6g-213-7015-20", "6g-215-7025-80", "6g-217-7035-20", "6g-219-7045-40", "6g-221-7055-20", "6g-225-7075-20", "6g-227-7085-40", "6g-229-7095-20", "6g-233-7115-20", "60g-1-58320-2160", "60g-2-60480-2160", "60g-3-62640-2160", "60g-4-64800-2160", "60g-5-66960-2160", "60g-6-69120-2160", "60g-9-59400-4320", "60g-10-61560-4320", "60g-11-63720-4320", "60g-12-65880-4320", "60g-13-68040-4320", "60g-17-60480-6480", "60g-18-62640-6480", "60g-19-64800-6480", "60g-20-66960-6480", "60g-25-61560-6480", "60g-26-63720-6480", "60g-27-65880-6480" ] }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "rf_channel_frequency": { "title": "Channel frequency (MHz)", "type": "number", "x-nullable": true }, "rf_channel_width": { "title": "Channel width (MHz)", "type": "number", "x-nullable": true }, "tx_power": { "title": "Transmit power (dBm)", "type": "integer", "maximum": 127, "minimum": 0, "x-nullable": true }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "wireless_link": { "title": "Wireless link", "type": "integer", "x-nullable": true }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "wireless_lans": { "type": "array", "items": { "title": "Wireless LANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInterfaces" }, "task": true }, { "name": "patchDcimInterfaces", "summary": "dcim_interfaces_bulk_partial_update", "description": "dcim_interfaces_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"lag\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"speed\": 123, \"duplex\": \"Must be one of [half, full, auto]\", \"wwn\": \"string\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"rf_role\": \"Must be one of [ap, station]\", \"rf_channel\": \"Must be one of [2.4g-1-2412-22, 2.4g-2-2417-22, 2.4g-3-2422-22, 2.4g-4-2427-22, 2.4g-5-2432-22, 2.4g-6-2437-22, 2.4g-7-2442-22, 2.4g-8-2447-22, 2.4g-9-2452-22, 2.4g-10-2457-22, 2.4g-11-2462-22, 2.4g-12-2467-22, 2.4g-13-2472-22, 5g-32-5160-20, 5g-34-5170-40, 5g-36-5180-20, 5g-38-5190-40, 5g-40-5200-20, 5g-42-5210-80, 5g-44-5220-20, 5g-46-5230-40, 5g-48-5240-20, 5g-50-5250-160, 5g-52-5260-20, 5g-54-5270-40, 5g-56-5280-20, 5g-58-5290-80, 5g-60-5300-20, 5g-62-5310-40, 5g-64-5320-20, 5g-100-5500-20, 5g-102-5510-40, 5g-104-5520-20, 5g-106-5530-80, 5g-108-5540-20, 5g-110-5550-40, 5g-112-5560-20, 5g-114-5570-160, 5g-116-5580-20, 5g-118-5590-40, 5g-120-5600-20, 5g-122-5610-80, 5g-124-5620-20, 5g-126-5630-40, 5g-128-5640-20, 5g-132-5660-20, 5g-134-5670-40, 5g-136-5680-20, 5g-138-5690-80, 5g-140-5700-20, 5g-142-5710-40, 5g-144-5720-20, 5g-149-5745-20, 5g-151-5755-40, 5g-153-5765-20, 5g-155-5775-80, 5g-157-5785-20, 5g-159-5795-40, 5g-161-5805-20, 5g-163-5815-160, 5g-165-5825-20, 5g-167-5835-40, 5g-169-5845-20, 5g-171-5855-80, 5g-173-5865-20, 5g-175-5875-40, 5g-177-5885-20, 6g-1-5955-20, 6g-3-5965-40, 6g-5-5975-20, 6g-7-5985-80, 6g-9-5995-20, 6g-11-6005-40, 6g-13-6015-20, 6g-15-6025-160, 6g-17-6035-20, 6g-19-6045-40, 6g-21-6055-20, 6g-23-6065-80, 6g-25-6075-20, 6g-27-6085-40, 6g-29-6095-20, 6g-31-6105-320, 6g-33-6115-20, 6g-35-6125-40, 6g-37-6135-20, 6g-39-6145-80, 6g-41-6155-20, 6g-43-6165-40, 6g-45-6175-20, 6g-47-6185-160, 6g-49-6195-20, 6g-51-6205-40, 6g-53-6215-20, 6g-55-6225-80, 6g-57-6235-20, 6g-59-6245-40, 6g-61-6255-20, 6g-65-6275-20, 6g-67-6285-40, 6g-69-6295-20, 6g-71-6305-80, 6g-73-6315-20, 6g-75-6325-40, 6g-77-6335-20, 6g-79-6345-160, 6g-81-6355-20, 6g-83-6365-40, 6g-85-6375-20, 6g-87-6385-80, 6g-89-6395-20, 6g-91-6405-40, 6g-93-6415-20, 6g-95-6425-320, 6g-97-6435-20, 6g-99-6445-40, 6g-101-6455-20, 6g-103-6465-80, 6g-105-6475-20, 6g-107-6485-40, 6g-109-6495-20, 6g-111-6505-160, 6g-113-6515-20, 6g-115-6525-40, 6g-117-6535-20, 6g-119-6545-80, 6g-121-6555-20, 6g-123-6565-40, 6g-125-6575-20, 6g-129-6595-20, 6g-131-6605-40, 6g-133-6615-20, 6g-135-6625-80, 6g-137-6635-20, 6g-139-6645-40, 6g-141-6655-20, 6g-143-6665-160, 6g-145-6675-20, 6g-147-6685-40, 6g-149-6695-20, 6g-151-6705-80, 6g-153-6715-20, 6g-155-6725-40, 6g-157-6735-20, 6g-159-6745-320, 6g-161-6755-20, 6g-163-6765-40, 6g-165-6775-20, 6g-167-6785-80, 6g-169-6795-20, 6g-171-6805-40, 6g-173-6815-20, 6g-175-6825-160, 6g-177-6835-20, 6g-179-6845-40, 6g-181-6855-20, 6g-183-6865-80, 6g-185-6875-20, 6g-187-6885-40, 6g-189-6895-20, 6g-193-6915-20, 6g-195-6925-40, 6g-197-6935-20, 6g-199-6945-80, 6g-201-6955-20, 6g-203-6965-40, 6g-205-6975-20, 6g-207-6985-160, 6g-209-6995-20, 6g-211-7005-40, 6g-213-7015-20, 6g-215-7025-80, 6g-217-7035-20, 6g-219-7045-40, 6g-221-7055-20, 6g-225-7075-20, 6g-227-7085-40, 6g-229-7095-20, 6g-233-7115-20, 60g-1-58320-2160, 60g-2-60480-2160, 60g-3-62640-2160, 60g-4-64800-2160, 60g-5-66960-2160, 60g-6-69120-2160, 60g-9-59400-4320, 60g-10-61560-4320, 60g-11-63720-4320, 60g-12-65880-4320, 60g-13-68040-4320, 60g-17-60480-6480, 60g-18-62640-6480, 60g-19-64800-6480, 60g-20-66960-6480, 60g-25-61560-6480, 60g-26-63720-6480, 60g-27-65880-6480]\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"rf_channel_frequency\": 123, \"rf_channel_width\": 123, \"tx_power\": 123, \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"wireless_link\": 123, \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"wireless_lans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123, \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "lag": { "title": "Parent LAG", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "speed": { "title": "Speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "duplex": { "title": "Duplex", "type": "string", "enum": [ "half", "full", "auto" ], "x-nullable": true }, "wwn": { "title": "WWN", "description": "64-bit World Wide Name", "type": "string", "x-nullable": true }, "mgmt_only": { "title": "Management only", "description": "This interface is used only for out-of-band management", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "rf_role": { "title": "Wireless role", "type": "string", "enum": [ "ap", "station" ] }, "rf_channel": { "title": "Wireless channel", "type": "string", "enum": [ "2.4g-1-2412-22", "2.4g-2-2417-22", "2.4g-3-2422-22", "2.4g-4-2427-22", "2.4g-5-2432-22", "2.4g-6-2437-22", "2.4g-7-2442-22", "2.4g-8-2447-22", "2.4g-9-2452-22", "2.4g-10-2457-22", "2.4g-11-2462-22", "2.4g-12-2467-22", "2.4g-13-2472-22", "5g-32-5160-20", "5g-34-5170-40", "5g-36-5180-20", "5g-38-5190-40", "5g-40-5200-20", "5g-42-5210-80", "5g-44-5220-20", "5g-46-5230-40", "5g-48-5240-20", "5g-50-5250-160", "5g-52-5260-20", "5g-54-5270-40", "5g-56-5280-20", "5g-58-5290-80", "5g-60-5300-20", "5g-62-5310-40", "5g-64-5320-20", "5g-100-5500-20", "5g-102-5510-40", "5g-104-5520-20", "5g-106-5530-80", "5g-108-5540-20", "5g-110-5550-40", "5g-112-5560-20", "5g-114-5570-160", "5g-116-5580-20", "5g-118-5590-40", "5g-120-5600-20", "5g-122-5610-80", "5g-124-5620-20", "5g-126-5630-40", "5g-128-5640-20", "5g-132-5660-20", "5g-134-5670-40", "5g-136-5680-20", "5g-138-5690-80", "5g-140-5700-20", "5g-142-5710-40", "5g-144-5720-20", "5g-149-5745-20", "5g-151-5755-40", "5g-153-5765-20", "5g-155-5775-80", "5g-157-5785-20", "5g-159-5795-40", "5g-161-5805-20", "5g-163-5815-160", "5g-165-5825-20", "5g-167-5835-40", "5g-169-5845-20", "5g-171-5855-80", "5g-173-5865-20", "5g-175-5875-40", "5g-177-5885-20", "6g-1-5955-20", "6g-3-5965-40", "6g-5-5975-20", "6g-7-5985-80", "6g-9-5995-20", "6g-11-6005-40", "6g-13-6015-20", "6g-15-6025-160", "6g-17-6035-20", "6g-19-6045-40", "6g-21-6055-20", "6g-23-6065-80", "6g-25-6075-20", "6g-27-6085-40", "6g-29-6095-20", "6g-31-6105-320", "6g-33-6115-20", "6g-35-6125-40", "6g-37-6135-20", "6g-39-6145-80", "6g-41-6155-20", "6g-43-6165-40", "6g-45-6175-20", "6g-47-6185-160", "6g-49-6195-20", "6g-51-6205-40", "6g-53-6215-20", "6g-55-6225-80", "6g-57-6235-20", "6g-59-6245-40", "6g-61-6255-20", "6g-65-6275-20", "6g-67-6285-40", "6g-69-6295-20", "6g-71-6305-80", "6g-73-6315-20", "6g-75-6325-40", "6g-77-6335-20", "6g-79-6345-160", "6g-81-6355-20", "6g-83-6365-40", "6g-85-6375-20", "6g-87-6385-80", "6g-89-6395-20", "6g-91-6405-40", "6g-93-6415-20", "6g-95-6425-320", "6g-97-6435-20", "6g-99-6445-40", "6g-101-6455-20", "6g-103-6465-80", "6g-105-6475-20", "6g-107-6485-40", "6g-109-6495-20", "6g-111-6505-160", "6g-113-6515-20", "6g-115-6525-40", "6g-117-6535-20", "6g-119-6545-80", "6g-121-6555-20", "6g-123-6565-40", "6g-125-6575-20", "6g-129-6595-20", "6g-131-6605-40", "6g-133-6615-20", "6g-135-6625-80", "6g-137-6635-20", "6g-139-6645-40", "6g-141-6655-20", "6g-143-6665-160", "6g-145-6675-20", "6g-147-6685-40", "6g-149-6695-20", "6g-151-6705-80", "6g-153-6715-20", "6g-155-6725-40", "6g-157-6735-20", "6g-159-6745-320", "6g-161-6755-20", "6g-163-6765-40", "6g-165-6775-20", "6g-167-6785-80", "6g-169-6795-20", "6g-171-6805-40", "6g-173-6815-20", "6g-175-6825-160", "6g-177-6835-20", "6g-179-6845-40", "6g-181-6855-20", "6g-183-6865-80", "6g-185-6875-20", "6g-187-6885-40", "6g-189-6895-20", "6g-193-6915-20", "6g-195-6925-40", "6g-197-6935-20", "6g-199-6945-80", "6g-201-6955-20", "6g-203-6965-40", "6g-205-6975-20", "6g-207-6985-160", "6g-209-6995-20", "6g-211-7005-40", "6g-213-7015-20", "6g-215-7025-80", "6g-217-7035-20", "6g-219-7045-40", "6g-221-7055-20", "6g-225-7075-20", "6g-227-7085-40", "6g-229-7095-20", "6g-233-7115-20", "60g-1-58320-2160", "60g-2-60480-2160", "60g-3-62640-2160", "60g-4-64800-2160", "60g-5-66960-2160", "60g-6-69120-2160", "60g-9-59400-4320", "60g-10-61560-4320", "60g-11-63720-4320", "60g-12-65880-4320", "60g-13-68040-4320", "60g-17-60480-6480", "60g-18-62640-6480", "60g-19-64800-6480", "60g-20-66960-6480", "60g-25-61560-6480", "60g-26-63720-6480", "60g-27-65880-6480" ] }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "rf_channel_frequency": { "title": "Channel frequency (MHz)", "type": "number", "x-nullable": true }, "rf_channel_width": { "title": "Channel width (MHz)", "type": "number", "x-nullable": true }, "tx_power": { "title": "Transmit power (dBm)", "type": "integer", "maximum": 127, "minimum": 0, "x-nullable": true }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "wireless_link": { "title": "Wireless link", "type": "integer", "x-nullable": true }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "wireless_lans": { "type": "array", "items": { "title": "Wireless LANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInterfaces" }, "task": true }, { "name": "deleteDcimInterfaces", "summary": "dcim_interfaces_bulk_delete", "description": "dcim_interfaces_bulk_delete", "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": "/deleteDcimInterfaces" }, "task": true }, { "name": "getDcimInterfacesId", "summary": "dcim_interfaces_read", "description": "dcim_interfaces_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimInterfacesId" }, "task": true }, { "name": "putDcimInterfacesId", "summary": "dcim_interfaces_update", "description": "dcim_interfaces_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"lag\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"speed\": 123, \"duplex\": \"Must be one of [half, full, auto]\", \"wwn\": \"string\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"rf_role\": \"Must be one of [ap, station]\", \"rf_channel\": \"Must be one of [2.4g-1-2412-22, 2.4g-2-2417-22, 2.4g-3-2422-22, 2.4g-4-2427-22, 2.4g-5-2432-22, 2.4g-6-2437-22, 2.4g-7-2442-22, 2.4g-8-2447-22, 2.4g-9-2452-22, 2.4g-10-2457-22, 2.4g-11-2462-22, 2.4g-12-2467-22, 2.4g-13-2472-22, 5g-32-5160-20, 5g-34-5170-40, 5g-36-5180-20, 5g-38-5190-40, 5g-40-5200-20, 5g-42-5210-80, 5g-44-5220-20, 5g-46-5230-40, 5g-48-5240-20, 5g-50-5250-160, 5g-52-5260-20, 5g-54-5270-40, 5g-56-5280-20, 5g-58-5290-80, 5g-60-5300-20, 5g-62-5310-40, 5g-64-5320-20, 5g-100-5500-20, 5g-102-5510-40, 5g-104-5520-20, 5g-106-5530-80, 5g-108-5540-20, 5g-110-5550-40, 5g-112-5560-20, 5g-114-5570-160, 5g-116-5580-20, 5g-118-5590-40, 5g-120-5600-20, 5g-122-5610-80, 5g-124-5620-20, 5g-126-5630-40, 5g-128-5640-20, 5g-132-5660-20, 5g-134-5670-40, 5g-136-5680-20, 5g-138-5690-80, 5g-140-5700-20, 5g-142-5710-40, 5g-144-5720-20, 5g-149-5745-20, 5g-151-5755-40, 5g-153-5765-20, 5g-155-5775-80, 5g-157-5785-20, 5g-159-5795-40, 5g-161-5805-20, 5g-163-5815-160, 5g-165-5825-20, 5g-167-5835-40, 5g-169-5845-20, 5g-171-5855-80, 5g-173-5865-20, 5g-175-5875-40, 5g-177-5885-20, 6g-1-5955-20, 6g-3-5965-40, 6g-5-5975-20, 6g-7-5985-80, 6g-9-5995-20, 6g-11-6005-40, 6g-13-6015-20, 6g-15-6025-160, 6g-17-6035-20, 6g-19-6045-40, 6g-21-6055-20, 6g-23-6065-80, 6g-25-6075-20, 6g-27-6085-40, 6g-29-6095-20, 6g-31-6105-320, 6g-33-6115-20, 6g-35-6125-40, 6g-37-6135-20, 6g-39-6145-80, 6g-41-6155-20, 6g-43-6165-40, 6g-45-6175-20, 6g-47-6185-160, 6g-49-6195-20, 6g-51-6205-40, 6g-53-6215-20, 6g-55-6225-80, 6g-57-6235-20, 6g-59-6245-40, 6g-61-6255-20, 6g-65-6275-20, 6g-67-6285-40, 6g-69-6295-20, 6g-71-6305-80, 6g-73-6315-20, 6g-75-6325-40, 6g-77-6335-20, 6g-79-6345-160, 6g-81-6355-20, 6g-83-6365-40, 6g-85-6375-20, 6g-87-6385-80, 6g-89-6395-20, 6g-91-6405-40, 6g-93-6415-20, 6g-95-6425-320, 6g-97-6435-20, 6g-99-6445-40, 6g-101-6455-20, 6g-103-6465-80, 6g-105-6475-20, 6g-107-6485-40, 6g-109-6495-20, 6g-111-6505-160, 6g-113-6515-20, 6g-115-6525-40, 6g-117-6535-20, 6g-119-6545-80, 6g-121-6555-20, 6g-123-6565-40, 6g-125-6575-20, 6g-129-6595-20, 6g-131-6605-40, 6g-133-6615-20, 6g-135-6625-80, 6g-137-6635-20, 6g-139-6645-40, 6g-141-6655-20, 6g-143-6665-160, 6g-145-6675-20, 6g-147-6685-40, 6g-149-6695-20, 6g-151-6705-80, 6g-153-6715-20, 6g-155-6725-40, 6g-157-6735-20, 6g-159-6745-320, 6g-161-6755-20, 6g-163-6765-40, 6g-165-6775-20, 6g-167-6785-80, 6g-169-6795-20, 6g-171-6805-40, 6g-173-6815-20, 6g-175-6825-160, 6g-177-6835-20, 6g-179-6845-40, 6g-181-6855-20, 6g-183-6865-80, 6g-185-6875-20, 6g-187-6885-40, 6g-189-6895-20, 6g-193-6915-20, 6g-195-6925-40, 6g-197-6935-20, 6g-199-6945-80, 6g-201-6955-20, 6g-203-6965-40, 6g-205-6975-20, 6g-207-6985-160, 6g-209-6995-20, 6g-211-7005-40, 6g-213-7015-20, 6g-215-7025-80, 6g-217-7035-20, 6g-219-7045-40, 6g-221-7055-20, 6g-225-7075-20, 6g-227-7085-40, 6g-229-7095-20, 6g-233-7115-20, 60g-1-58320-2160, 60g-2-60480-2160, 60g-3-62640-2160, 60g-4-64800-2160, 60g-5-66960-2160, 60g-6-69120-2160, 60g-9-59400-4320, 60g-10-61560-4320, 60g-11-63720-4320, 60g-12-65880-4320, 60g-13-68040-4320, 60g-17-60480-6480, 60g-18-62640-6480, 60g-19-64800-6480, 60g-20-66960-6480, 60g-25-61560-6480, 60g-26-63720-6480, 60g-27-65880-6480]\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"rf_channel_frequency\": 123, \"rf_channel_width\": 123, \"tx_power\": 123, \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"wireless_link\": 123, \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"wireless_lans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123, \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "lag": { "title": "Parent LAG", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "speed": { "title": "Speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "duplex": { "title": "Duplex", "type": "string", "enum": [ "half", "full", "auto" ], "x-nullable": true }, "wwn": { "title": "WWN", "description": "64-bit World Wide Name", "type": "string", "x-nullable": true }, "mgmt_only": { "title": "Management only", "description": "This interface is used only for out-of-band management", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "rf_role": { "title": "Wireless role", "type": "string", "enum": [ "ap", "station" ] }, "rf_channel": { "title": "Wireless channel", "type": "string", "enum": [ "2.4g-1-2412-22", "2.4g-2-2417-22", "2.4g-3-2422-22", "2.4g-4-2427-22", "2.4g-5-2432-22", "2.4g-6-2437-22", "2.4g-7-2442-22", "2.4g-8-2447-22", "2.4g-9-2452-22", "2.4g-10-2457-22", "2.4g-11-2462-22", "2.4g-12-2467-22", "2.4g-13-2472-22", "5g-32-5160-20", "5g-34-5170-40", "5g-36-5180-20", "5g-38-5190-40", "5g-40-5200-20", "5g-42-5210-80", "5g-44-5220-20", "5g-46-5230-40", "5g-48-5240-20", "5g-50-5250-160", "5g-52-5260-20", "5g-54-5270-40", "5g-56-5280-20", "5g-58-5290-80", "5g-60-5300-20", "5g-62-5310-40", "5g-64-5320-20", "5g-100-5500-20", "5g-102-5510-40", "5g-104-5520-20", "5g-106-5530-80", "5g-108-5540-20", "5g-110-5550-40", "5g-112-5560-20", "5g-114-5570-160", "5g-116-5580-20", "5g-118-5590-40", "5g-120-5600-20", "5g-122-5610-80", "5g-124-5620-20", "5g-126-5630-40", "5g-128-5640-20", "5g-132-5660-20", "5g-134-5670-40", "5g-136-5680-20", "5g-138-5690-80", "5g-140-5700-20", "5g-142-5710-40", "5g-144-5720-20", "5g-149-5745-20", "5g-151-5755-40", "5g-153-5765-20", "5g-155-5775-80", "5g-157-5785-20", "5g-159-5795-40", "5g-161-5805-20", "5g-163-5815-160", "5g-165-5825-20", "5g-167-5835-40", "5g-169-5845-20", "5g-171-5855-80", "5g-173-5865-20", "5g-175-5875-40", "5g-177-5885-20", "6g-1-5955-20", "6g-3-5965-40", "6g-5-5975-20", "6g-7-5985-80", "6g-9-5995-20", "6g-11-6005-40", "6g-13-6015-20", "6g-15-6025-160", "6g-17-6035-20", "6g-19-6045-40", "6g-21-6055-20", "6g-23-6065-80", "6g-25-6075-20", "6g-27-6085-40", "6g-29-6095-20", "6g-31-6105-320", "6g-33-6115-20", "6g-35-6125-40", "6g-37-6135-20", "6g-39-6145-80", "6g-41-6155-20", "6g-43-6165-40", "6g-45-6175-20", "6g-47-6185-160", "6g-49-6195-20", "6g-51-6205-40", "6g-53-6215-20", "6g-55-6225-80", "6g-57-6235-20", "6g-59-6245-40", "6g-61-6255-20", "6g-65-6275-20", "6g-67-6285-40", "6g-69-6295-20", "6g-71-6305-80", "6g-73-6315-20", "6g-75-6325-40", "6g-77-6335-20", "6g-79-6345-160", "6g-81-6355-20", "6g-83-6365-40", "6g-85-6375-20", "6g-87-6385-80", "6g-89-6395-20", "6g-91-6405-40", "6g-93-6415-20", "6g-95-6425-320", "6g-97-6435-20", "6g-99-6445-40", "6g-101-6455-20", "6g-103-6465-80", "6g-105-6475-20", "6g-107-6485-40", "6g-109-6495-20", "6g-111-6505-160", "6g-113-6515-20", "6g-115-6525-40", "6g-117-6535-20", "6g-119-6545-80", "6g-121-6555-20", "6g-123-6565-40", "6g-125-6575-20", "6g-129-6595-20", "6g-131-6605-40", "6g-133-6615-20", "6g-135-6625-80", "6g-137-6635-20", "6g-139-6645-40", "6g-141-6655-20", "6g-143-6665-160", "6g-145-6675-20", "6g-147-6685-40", "6g-149-6695-20", "6g-151-6705-80", "6g-153-6715-20", "6g-155-6725-40", "6g-157-6735-20", "6g-159-6745-320", "6g-161-6755-20", "6g-163-6765-40", "6g-165-6775-20", "6g-167-6785-80", "6g-169-6795-20", "6g-171-6805-40", "6g-173-6815-20", "6g-175-6825-160", "6g-177-6835-20", "6g-179-6845-40", "6g-181-6855-20", "6g-183-6865-80", "6g-185-6875-20", "6g-187-6885-40", "6g-189-6895-20", "6g-193-6915-20", "6g-195-6925-40", "6g-197-6935-20", "6g-199-6945-80", "6g-201-6955-20", "6g-203-6965-40", "6g-205-6975-20", "6g-207-6985-160", "6g-209-6995-20", "6g-211-7005-40", "6g-213-7015-20", "6g-215-7025-80", "6g-217-7035-20", "6g-219-7045-40", "6g-221-7055-20", "6g-225-7075-20", "6g-227-7085-40", "6g-229-7095-20", "6g-233-7115-20", "60g-1-58320-2160", "60g-2-60480-2160", "60g-3-62640-2160", "60g-4-64800-2160", "60g-5-66960-2160", "60g-6-69120-2160", "60g-9-59400-4320", "60g-10-61560-4320", "60g-11-63720-4320", "60g-12-65880-4320", "60g-13-68040-4320", "60g-17-60480-6480", "60g-18-62640-6480", "60g-19-64800-6480", "60g-20-66960-6480", "60g-25-61560-6480", "60g-26-63720-6480", "60g-27-65880-6480" ] }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "rf_channel_frequency": { "title": "Channel frequency (MHz)", "type": "number", "x-nullable": true }, "rf_channel_width": { "title": "Channel width (MHz)", "type": "number", "x-nullable": true }, "tx_power": { "title": "Transmit power (dBm)", "type": "integer", "maximum": 127, "minimum": 0, "x-nullable": true }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "wireless_link": { "title": "Wireless link", "type": "integer", "x-nullable": true }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "wireless_lans": { "type": "array", "items": { "title": "Wireless LANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInterfacesId" }, "task": true }, { "name": "patchDcimInterfacesId", "summary": "dcim_interfaces_partial_update", "description": "dcim_interfaces_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [virtual, bridge, lag, 100base-tx, 1000base-t, 2.5gbase-t, 5gbase-t, 10gbase-t, 10gbase-cx4, 1000base-x-gbic, 1000base-x-sfp, 10gbase-x-sfpp, 10gbase-x-xfp, 10gbase-x-xenpak, 10gbase-x-x2, 25gbase-x-sfp28, 50gbase-x-sfp56, 40gbase-x-qsfpp, 50gbase-x-sfp28, 100gbase-x-cfp, 100gbase-x-cfp2, 200gbase-x-cfp2, 100gbase-x-cfp4, 100gbase-x-cpak, 100gbase-x-qsfp28, 200gbase-x-qsfp56, 400gbase-x-qsfpdd, 400gbase-x-osfp, ieee802.11a, ieee802.11g, ieee802.11n, ieee802.11ac, ieee802.11ad, ieee802.11ax, ieee802.11ay, ieee802.15.1, other-wireless, gsm, cdma, lte, sonet-oc3, sonet-oc12, sonet-oc48, sonet-oc192, sonet-oc768, sonet-oc1920, sonet-oc3840, 1gfc-sfp, 2gfc-sfp, 4gfc-sfp, 8gfc-sfpp, 16gfc-sfpp, 32gfc-sfp28, 64gfc-qsfpp, 128gfc-qsfp28, infiniband-sdr, infiniband-ddr, infiniband-qdr, infiniband-fdr10, infiniband-fdr, infiniband-edr, infiniband-hdr, infiniband-ndr, infiniband-xdr, t1, e1, t3, e3, xdsl, docsis, gpon, xg-pon, xgs-pon, ng-pon2, epon, 10g-epon, cisco-stackwise, cisco-stackwise-plus, cisco-flexstack, cisco-flexstack-plus, cisco-stackwise-80, cisco-stackwise-160, cisco-stackwise-320, cisco-stackwise-480, juniper-vcp, extreme-summitstack, extreme-summitstack-128, extreme-summitstack-256, extreme-summitstack-512, other]\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"lag\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"speed\": 123, \"duplex\": \"Must be one of [half, full, auto]\", \"wwn\": \"string\", \"mgmt_only\": \"boolean\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"rf_role\": \"Must be one of [ap, station]\", \"rf_channel\": \"Must be one of [2.4g-1-2412-22, 2.4g-2-2417-22, 2.4g-3-2422-22, 2.4g-4-2427-22, 2.4g-5-2432-22, 2.4g-6-2437-22, 2.4g-7-2442-22, 2.4g-8-2447-22, 2.4g-9-2452-22, 2.4g-10-2457-22, 2.4g-11-2462-22, 2.4g-12-2467-22, 2.4g-13-2472-22, 5g-32-5160-20, 5g-34-5170-40, 5g-36-5180-20, 5g-38-5190-40, 5g-40-5200-20, 5g-42-5210-80, 5g-44-5220-20, 5g-46-5230-40, 5g-48-5240-20, 5g-50-5250-160, 5g-52-5260-20, 5g-54-5270-40, 5g-56-5280-20, 5g-58-5290-80, 5g-60-5300-20, 5g-62-5310-40, 5g-64-5320-20, 5g-100-5500-20, 5g-102-5510-40, 5g-104-5520-20, 5g-106-5530-80, 5g-108-5540-20, 5g-110-5550-40, 5g-112-5560-20, 5g-114-5570-160, 5g-116-5580-20, 5g-118-5590-40, 5g-120-5600-20, 5g-122-5610-80, 5g-124-5620-20, 5g-126-5630-40, 5g-128-5640-20, 5g-132-5660-20, 5g-134-5670-40, 5g-136-5680-20, 5g-138-5690-80, 5g-140-5700-20, 5g-142-5710-40, 5g-144-5720-20, 5g-149-5745-20, 5g-151-5755-40, 5g-153-5765-20, 5g-155-5775-80, 5g-157-5785-20, 5g-159-5795-40, 5g-161-5805-20, 5g-163-5815-160, 5g-165-5825-20, 5g-167-5835-40, 5g-169-5845-20, 5g-171-5855-80, 5g-173-5865-20, 5g-175-5875-40, 5g-177-5885-20, 6g-1-5955-20, 6g-3-5965-40, 6g-5-5975-20, 6g-7-5985-80, 6g-9-5995-20, 6g-11-6005-40, 6g-13-6015-20, 6g-15-6025-160, 6g-17-6035-20, 6g-19-6045-40, 6g-21-6055-20, 6g-23-6065-80, 6g-25-6075-20, 6g-27-6085-40, 6g-29-6095-20, 6g-31-6105-320, 6g-33-6115-20, 6g-35-6125-40, 6g-37-6135-20, 6g-39-6145-80, 6g-41-6155-20, 6g-43-6165-40, 6g-45-6175-20, 6g-47-6185-160, 6g-49-6195-20, 6g-51-6205-40, 6g-53-6215-20, 6g-55-6225-80, 6g-57-6235-20, 6g-59-6245-40, 6g-61-6255-20, 6g-65-6275-20, 6g-67-6285-40, 6g-69-6295-20, 6g-71-6305-80, 6g-73-6315-20, 6g-75-6325-40, 6g-77-6335-20, 6g-79-6345-160, 6g-81-6355-20, 6g-83-6365-40, 6g-85-6375-20, 6g-87-6385-80, 6g-89-6395-20, 6g-91-6405-40, 6g-93-6415-20, 6g-95-6425-320, 6g-97-6435-20, 6g-99-6445-40, 6g-101-6455-20, 6g-103-6465-80, 6g-105-6475-20, 6g-107-6485-40, 6g-109-6495-20, 6g-111-6505-160, 6g-113-6515-20, 6g-115-6525-40, 6g-117-6535-20, 6g-119-6545-80, 6g-121-6555-20, 6g-123-6565-40, 6g-125-6575-20, 6g-129-6595-20, 6g-131-6605-40, 6g-133-6615-20, 6g-135-6625-80, 6g-137-6635-20, 6g-139-6645-40, 6g-141-6655-20, 6g-143-6665-160, 6g-145-6675-20, 6g-147-6685-40, 6g-149-6695-20, 6g-151-6705-80, 6g-153-6715-20, 6g-155-6725-40, 6g-157-6735-20, 6g-159-6745-320, 6g-161-6755-20, 6g-163-6765-40, 6g-165-6775-20, 6g-167-6785-80, 6g-169-6795-20, 6g-171-6805-40, 6g-173-6815-20, 6g-175-6825-160, 6g-177-6835-20, 6g-179-6845-40, 6g-181-6855-20, 6g-183-6865-80, 6g-185-6875-20, 6g-187-6885-40, 6g-189-6895-20, 6g-193-6915-20, 6g-195-6925-40, 6g-197-6935-20, 6g-199-6945-80, 6g-201-6955-20, 6g-203-6965-40, 6g-205-6975-20, 6g-207-6985-160, 6g-209-6995-20, 6g-211-7005-40, 6g-213-7015-20, 6g-215-7025-80, 6g-217-7035-20, 6g-219-7045-40, 6g-221-7055-20, 6g-225-7075-20, 6g-227-7085-40, 6g-229-7095-20, 6g-233-7115-20, 60g-1-58320-2160, 60g-2-60480-2160, 60g-3-62640-2160, 60g-4-64800-2160, 60g-5-66960-2160, 60g-6-69120-2160, 60g-9-59400-4320, 60g-10-61560-4320, 60g-11-63720-4320, 60g-12-65880-4320, 60g-13-68040-4320, 60g-17-60480-6480, 60g-18-62640-6480, 60g-19-64800-6480, 60g-20-66960-6480, 60g-25-61560-6480, 60g-26-63720-6480, 60g-27-65880-6480]\", \"poe_mode\": \"Must be one of [pd, pse]\", \"poe_type\": \"Must be one of [type1-ieee802.3af, type2-ieee802.3at, type3-ieee802.3bt, type4-ieee802.3bt, passive-24v-2pair, passive-24v-4pair, passive-48v-2pair, passive-48v-4pair]\", \"rf_channel_frequency\": 123, \"rf_channel_width\": 123, \"tx_power\": 123, \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"wireless_link\": 123, \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"wireless_lans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123, \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "virtual", "bridge", "lag", "100base-tx", "1000base-t", "2.5gbase-t", "5gbase-t", "10gbase-t", "10gbase-cx4", "1000base-x-gbic", "1000base-x-sfp", "10gbase-x-sfpp", "10gbase-x-xfp", "10gbase-x-xenpak", "10gbase-x-x2", "25gbase-x-sfp28", "50gbase-x-sfp56", "40gbase-x-qsfpp", "50gbase-x-sfp28", "100gbase-x-cfp", "100gbase-x-cfp2", "200gbase-x-cfp2", "100gbase-x-cfp4", "100gbase-x-cpak", "100gbase-x-qsfp28", "200gbase-x-qsfp56", "400gbase-x-qsfpdd", "400gbase-x-osfp", "ieee802.11a", "ieee802.11g", "ieee802.11n", "ieee802.11ac", "ieee802.11ad", "ieee802.11ax", "ieee802.11ay", "ieee802.15.1", "other-wireless", "gsm", "cdma", "lte", "sonet-oc3", "sonet-oc12", "sonet-oc48", "sonet-oc192", "sonet-oc768", "sonet-oc1920", "sonet-oc3840", "1gfc-sfp", "2gfc-sfp", "4gfc-sfp", "8gfc-sfpp", "16gfc-sfpp", "32gfc-sfp28", "64gfc-qsfpp", "128gfc-qsfp28", "infiniband-sdr", "infiniband-ddr", "infiniband-qdr", "infiniband-fdr10", "infiniband-fdr", "infiniband-edr", "infiniband-hdr", "infiniband-ndr", "infiniband-xdr", "t1", "e1", "t3", "e3", "xdsl", "docsis", "gpon", "xg-pon", "xgs-pon", "ng-pon2", "epon", "10g-epon", "cisco-stackwise", "cisco-stackwise-plus", "cisco-flexstack", "cisco-flexstack-plus", "cisco-stackwise-80", "cisco-stackwise-160", "cisco-stackwise-320", "cisco-stackwise-480", "juniper-vcp", "extreme-summitstack", "extreme-summitstack-128", "extreme-summitstack-256", "extreme-summitstack-512", "other" ] }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "lag": { "title": "Parent LAG", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "speed": { "title": "Speed (Kbps)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "duplex": { "title": "Duplex", "type": "string", "enum": [ "half", "full", "auto" ], "x-nullable": true }, "wwn": { "title": "WWN", "description": "64-bit World Wide Name", "type": "string", "x-nullable": true }, "mgmt_only": { "title": "Management only", "description": "This interface is used only for out-of-band management", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "rf_role": { "title": "Wireless role", "type": "string", "enum": [ "ap", "station" ] }, "rf_channel": { "title": "Wireless channel", "type": "string", "enum": [ "2.4g-1-2412-22", "2.4g-2-2417-22", "2.4g-3-2422-22", "2.4g-4-2427-22", "2.4g-5-2432-22", "2.4g-6-2437-22", "2.4g-7-2442-22", "2.4g-8-2447-22", "2.4g-9-2452-22", "2.4g-10-2457-22", "2.4g-11-2462-22", "2.4g-12-2467-22", "2.4g-13-2472-22", "5g-32-5160-20", "5g-34-5170-40", "5g-36-5180-20", "5g-38-5190-40", "5g-40-5200-20", "5g-42-5210-80", "5g-44-5220-20", "5g-46-5230-40", "5g-48-5240-20", "5g-50-5250-160", "5g-52-5260-20", "5g-54-5270-40", "5g-56-5280-20", "5g-58-5290-80", "5g-60-5300-20", "5g-62-5310-40", "5g-64-5320-20", "5g-100-5500-20", "5g-102-5510-40", "5g-104-5520-20", "5g-106-5530-80", "5g-108-5540-20", "5g-110-5550-40", "5g-112-5560-20", "5g-114-5570-160", "5g-116-5580-20", "5g-118-5590-40", "5g-120-5600-20", "5g-122-5610-80", "5g-124-5620-20", "5g-126-5630-40", "5g-128-5640-20", "5g-132-5660-20", "5g-134-5670-40", "5g-136-5680-20", "5g-138-5690-80", "5g-140-5700-20", "5g-142-5710-40", "5g-144-5720-20", "5g-149-5745-20", "5g-151-5755-40", "5g-153-5765-20", "5g-155-5775-80", "5g-157-5785-20", "5g-159-5795-40", "5g-161-5805-20", "5g-163-5815-160", "5g-165-5825-20", "5g-167-5835-40", "5g-169-5845-20", "5g-171-5855-80", "5g-173-5865-20", "5g-175-5875-40", "5g-177-5885-20", "6g-1-5955-20", "6g-3-5965-40", "6g-5-5975-20", "6g-7-5985-80", "6g-9-5995-20", "6g-11-6005-40", "6g-13-6015-20", "6g-15-6025-160", "6g-17-6035-20", "6g-19-6045-40", "6g-21-6055-20", "6g-23-6065-80", "6g-25-6075-20", "6g-27-6085-40", "6g-29-6095-20", "6g-31-6105-320", "6g-33-6115-20", "6g-35-6125-40", "6g-37-6135-20", "6g-39-6145-80", "6g-41-6155-20", "6g-43-6165-40", "6g-45-6175-20", "6g-47-6185-160", "6g-49-6195-20", "6g-51-6205-40", "6g-53-6215-20", "6g-55-6225-80", "6g-57-6235-20", "6g-59-6245-40", "6g-61-6255-20", "6g-65-6275-20", "6g-67-6285-40", "6g-69-6295-20", "6g-71-6305-80", "6g-73-6315-20", "6g-75-6325-40", "6g-77-6335-20", "6g-79-6345-160", "6g-81-6355-20", "6g-83-6365-40", "6g-85-6375-20", "6g-87-6385-80", "6g-89-6395-20", "6g-91-6405-40", "6g-93-6415-20", "6g-95-6425-320", "6g-97-6435-20", "6g-99-6445-40", "6g-101-6455-20", "6g-103-6465-80", "6g-105-6475-20", "6g-107-6485-40", "6g-109-6495-20", "6g-111-6505-160", "6g-113-6515-20", "6g-115-6525-40", "6g-117-6535-20", "6g-119-6545-80", "6g-121-6555-20", "6g-123-6565-40", "6g-125-6575-20", "6g-129-6595-20", "6g-131-6605-40", "6g-133-6615-20", "6g-135-6625-80", "6g-137-6635-20", "6g-139-6645-40", "6g-141-6655-20", "6g-143-6665-160", "6g-145-6675-20", "6g-147-6685-40", "6g-149-6695-20", "6g-151-6705-80", "6g-153-6715-20", "6g-155-6725-40", "6g-157-6735-20", "6g-159-6745-320", "6g-161-6755-20", "6g-163-6765-40", "6g-165-6775-20", "6g-167-6785-80", "6g-169-6795-20", "6g-171-6805-40", "6g-173-6815-20", "6g-175-6825-160", "6g-177-6835-20", "6g-179-6845-40", "6g-181-6855-20", "6g-183-6865-80", "6g-185-6875-20", "6g-187-6885-40", "6g-189-6895-20", "6g-193-6915-20", "6g-195-6925-40", "6g-197-6935-20", "6g-199-6945-80", "6g-201-6955-20", "6g-203-6965-40", "6g-205-6975-20", "6g-207-6985-160", "6g-209-6995-20", "6g-211-7005-40", "6g-213-7015-20", "6g-215-7025-80", "6g-217-7035-20", "6g-219-7045-40", "6g-221-7055-20", "6g-225-7075-20", "6g-227-7085-40", "6g-229-7095-20", "6g-233-7115-20", "60g-1-58320-2160", "60g-2-60480-2160", "60g-3-62640-2160", "60g-4-64800-2160", "60g-5-66960-2160", "60g-6-69120-2160", "60g-9-59400-4320", "60g-10-61560-4320", "60g-11-63720-4320", "60g-12-65880-4320", "60g-13-68040-4320", "60g-17-60480-6480", "60g-18-62640-6480", "60g-19-64800-6480", "60g-20-66960-6480", "60g-25-61560-6480", "60g-26-63720-6480", "60g-27-65880-6480" ] }, "poe_mode": { "title": "PoE mode", "type": "string", "enum": [ "pd", "pse" ] }, "poe_type": { "title": "PoE type", "type": "string", "enum": [ "type1-ieee802.3af", "type2-ieee802.3at", "type3-ieee802.3bt", "type4-ieee802.3bt", "passive-24v-2pair", "passive-24v-4pair", "passive-48v-2pair", "passive-48v-4pair" ] }, "rf_channel_frequency": { "title": "Channel frequency (MHz)", "type": "number", "x-nullable": true }, "rf_channel_width": { "title": "Channel width (MHz)", "type": "number", "x-nullable": true }, "tx_power": { "title": "Transmit power (dBm)", "type": "integer", "maximum": 127, "minimum": 0, "x-nullable": true }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "wireless_link": { "title": "Wireless link", "type": "integer", "x-nullable": true }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "wireless_lans": { "type": "array", "items": { "title": "Wireless LANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInterfacesId" }, "task": true }, { "name": "deleteDcimInterfacesId", "summary": "dcim_interfaces_delete", "description": "dcim_interfaces_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimInterfacesId" }, "task": true }, { "name": "getDcimInterfacesIdTrace", "summary": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin", "description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimInterfacesIdTrace" }, "task": true }, { "name": "getDcimInventoryItemRoles", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "colorIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIc", "type": "string" } }, { "name": "colorNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNic", "type": "string" } }, { "name": "colorIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIew", "type": "string" } }, { "name": "colorNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNiew", "type": "string" } }, { "name": "colorIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIsw", "type": "string" } }, { "name": "colorNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNisw", "type": "string" } }, { "name": "colorIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIe", "type": "string" } }, { "name": "colorNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimInventoryItemRoles" }, "task": true }, { "name": "postDcimInventoryItemRoles", "summary": "dcim_inventory-item-roles_create", "description": "dcim_inventory-item-roles_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"inventoryitem_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimInventoryItemRoles" }, "task": true }, { "name": "putDcimInventoryItemRoles", "summary": "dcim_inventory-item-roles_bulk_update", "description": "dcim_inventory-item-roles_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"inventoryitem_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInventoryItemRoles" }, "task": true }, { "name": "patchDcimInventoryItemRoles", "summary": "dcim_inventory-item-roles_bulk_partial_update", "description": "dcim_inventory-item-roles_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"inventoryitem_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInventoryItemRoles" }, "task": true }, { "name": "deleteDcimInventoryItemRoles", "summary": "dcim_inventory-item-roles_bulk_delete", "description": "dcim_inventory-item-roles_bulk_delete", "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": "/deleteDcimInventoryItemRoles" }, "task": true }, { "name": "getDcimInventoryItemRolesId", "summary": "dcim_inventory-item-roles_read", "description": "dcim_inventory-item-roles_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item role.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimInventoryItemRolesId" }, "task": true }, { "name": "putDcimInventoryItemRolesId", "summary": "dcim_inventory-item-roles_update", "description": "dcim_inventory-item-roles_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"inventoryitem_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInventoryItemRolesId" }, "task": true }, { "name": "patchDcimInventoryItemRolesId", "summary": "dcim_inventory-item-roles_partial_update", "description": "dcim_inventory-item-roles_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"inventoryitem_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInventoryItemRolesId" }, "task": true }, { "name": "deleteDcimInventoryItemRolesId", "summary": "dcim_inventory-item-roles_delete", "description": "dcim_inventory-item-roles_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item role.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimInventoryItemRolesId" }, "task": true }, { "name": "getDcimInventoryItemTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "partId", "type": "string", "info": ": string", "required": false, "schema": { "title": "partId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "manufacturerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerId", "type": "string" } }, { "name": "manufacturer", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturer", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "componentType", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentType", "type": "string" } }, { "name": "componentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "partIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdN", "type": "string" } }, { "name": "partIdIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdIc", "type": "string" } }, { "name": "partIdNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdNic", "type": "string" } }, { "name": "partIdIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdIew", "type": "string" } }, { "name": "partIdNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdNiew", "type": "string" } }, { "name": "partIdIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdIsw", "type": "string" } }, { "name": "partIdNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdNisw", "type": "string" } }, { "name": "partIdIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdIe", "type": "string" } }, { "name": "partIdNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "manufacturerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerIdN", "type": "string" } }, { "name": "manufacturerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "componentTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentTypeN", "type": "string" } }, { "name": "componentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdN", "type": "string" } }, { "name": "componentIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdLte", "type": "string" } }, { "name": "componentIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdLt", "type": "string" } }, { "name": "componentIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdGte", "type": "string" } }, { "name": "componentIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdGt", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimInventoryItemTemplates" }, "task": true }, { "name": "postDcimInventoryItemTemplates", "summary": "dcim_inventory-item-templates_create", "description": "dcim_inventory-item-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimInventoryItemTemplates" }, "task": true }, { "name": "putDcimInventoryItemTemplates", "summary": "dcim_inventory-item-templates_bulk_update", "description": "dcim_inventory-item-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInventoryItemTemplates" }, "task": true }, { "name": "patchDcimInventoryItemTemplates", "summary": "dcim_inventory-item-templates_bulk_partial_update", "description": "dcim_inventory-item-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInventoryItemTemplates" }, "task": true }, { "name": "deleteDcimInventoryItemTemplates", "summary": "dcim_inventory-item-templates_bulk_delete", "description": "dcim_inventory-item-templates_bulk_delete", "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": "/deleteDcimInventoryItemTemplates" }, "task": true }, { "name": "getDcimInventoryItemTemplatesId", "summary": "dcim_inventory-item-templates_read", "description": "dcim_inventory-item-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimInventoryItemTemplatesId" }, "task": true }, { "name": "putDcimInventoryItemTemplatesId", "summary": "dcim_inventory-item-templates_update", "description": "dcim_inventory-item-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInventoryItemTemplatesId" }, "task": true }, { "name": "patchDcimInventoryItemTemplatesId", "summary": "dcim_inventory-item-templates_partial_update", "description": "dcim_inventory-item-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInventoryItemTemplatesId" }, "task": true }, { "name": "deleteDcimInventoryItemTemplatesId", "summary": "dcim_inventory-item-templates_delete", "description": "dcim_inventory-item-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimInventoryItemTemplatesId" }, "task": true }, { "name": "getDcimInventoryItems", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "partId", "type": "string", "info": ": string", "required": false, "schema": { "title": "partId", "type": "string" } }, { "name": "assetTag", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTag", "type": "string" } }, { "name": "discovered", "type": "string", "info": ": string", "required": false, "schema": { "title": "discovered", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "manufacturerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerId", "type": "string" } }, { "name": "manufacturer", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturer", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "componentType", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentType", "type": "string" } }, { "name": "componentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentId", "type": "string" } }, { "name": "serial", "type": "string", "info": ": string", "required": false, "schema": { "title": "serial", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "partIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdN", "type": "string" } }, { "name": "partIdIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdIc", "type": "string" } }, { "name": "partIdNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdNic", "type": "string" } }, { "name": "partIdIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdIew", "type": "string" } }, { "name": "partIdNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdNiew", "type": "string" } }, { "name": "partIdIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdIsw", "type": "string" } }, { "name": "partIdNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdNisw", "type": "string" } }, { "name": "partIdIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdIe", "type": "string" } }, { "name": "partIdNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "partIdNie", "type": "string" } }, { "name": "assetTagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagN", "type": "string" } }, { "name": "assetTagIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIc", "type": "string" } }, { "name": "assetTagNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNic", "type": "string" } }, { "name": "assetTagIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIew", "type": "string" } }, { "name": "assetTagNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNiew", "type": "string" } }, { "name": "assetTagIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIsw", "type": "string" } }, { "name": "assetTagNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNisw", "type": "string" } }, { "name": "assetTagIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIe", "type": "string" } }, { "name": "assetTagNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNie", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "manufacturerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerIdN", "type": "string" } }, { "name": "manufacturerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "componentTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentTypeN", "type": "string" } }, { "name": "componentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdN", "type": "string" } }, { "name": "componentIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdLte", "type": "string" } }, { "name": "componentIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdLt", "type": "string" } }, { "name": "componentIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdGte", "type": "string" } }, { "name": "componentIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "componentIdGt", "type": "string" } }, { "name": "serialN", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialN", "type": "string" } }, { "name": "serialIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIc", "type": "string" } }, { "name": "serialNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNic", "type": "string" } }, { "name": "serialIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIew", "type": "string" } }, { "name": "serialNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNiew", "type": "string" } }, { "name": "serialIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIsw", "type": "string" } }, { "name": "serialNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNisw", "type": "string" } }, { "name": "serialIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIe", "type": "string" } }, { "name": "serialNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNie", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this item", "type": "string", "maxLength": 50, "x-nullable": true }, "discovered": { "title": "Discovered", "description": "This item was automatically discovered", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimInventoryItems" }, "task": true }, { "name": "postDcimInventoryItems", "summary": "dcim_inventory-items_create", "description": "dcim_inventory-items_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"serial\": \"string\", \"asset_tag\": \"string\", \"discovered\": \"boolean\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this item", "type": "string", "maxLength": 50, "x-nullable": true }, "discovered": { "title": "Discovered", "description": "This item was automatically discovered", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimInventoryItems" }, "task": true }, { "name": "putDcimInventoryItems", "summary": "dcim_inventory-items_bulk_update", "description": "dcim_inventory-items_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"serial\": \"string\", \"asset_tag\": \"string\", \"discovered\": \"boolean\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this item", "type": "string", "maxLength": 50, "x-nullable": true }, "discovered": { "title": "Discovered", "description": "This item was automatically discovered", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInventoryItems" }, "task": true }, { "name": "patchDcimInventoryItems", "summary": "dcim_inventory-items_bulk_partial_update", "description": "dcim_inventory-items_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"serial\": \"string\", \"asset_tag\": \"string\", \"discovered\": \"boolean\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this item", "type": "string", "maxLength": 50, "x-nullable": true }, "discovered": { "title": "Discovered", "description": "This item was automatically discovered", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInventoryItems" }, "task": true }, { "name": "deleteDcimInventoryItems", "summary": "dcim_inventory-items_bulk_delete", "description": "dcim_inventory-items_bulk_delete", "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": "/deleteDcimInventoryItems" }, "task": true }, { "name": "getDcimInventoryItemsId", "summary": "dcim_inventory-items_read", "description": "dcim_inventory-items_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimInventoryItemsId" }, "task": true }, { "name": "putDcimInventoryItemsId", "summary": "dcim_inventory-items_update", "description": "dcim_inventory-items_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"serial\": \"string\", \"asset_tag\": \"string\", \"discovered\": \"boolean\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this item", "type": "string", "maxLength": 50, "x-nullable": true }, "discovered": { "title": "Discovered", "description": "This item was automatically discovered", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimInventoryItemsId" }, "task": true }, { "name": "patchDcimInventoryItemsId", "summary": "dcim_inventory-items_partial_update", "description": "dcim_inventory-items_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"parent\": 123, \"name\": \"string\", \"label\": \"string\", \"role\": 123, \"manufacturer\": 123, \"part_id\": \"string\", \"serial\": \"string\", \"asset_tag\": \"string\", \"discovered\": \"boolean\", \"description\": \"string\", \"component_type\": \"string\", \"component_id\": 123, \"component\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_depth\": 123}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "manufacturer": { "title": "Manufacturer", "type": "integer", "x-nullable": true }, "part_id": { "title": "Part ID", "description": "Manufacturer-assigned part identifier", "type": "string", "maxLength": 50 }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this item", "type": "string", "maxLength": 50, "x-nullable": true }, "discovered": { "title": "Discovered", "description": "This item was automatically discovered", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "component_type": { "title": "Component type", "type": "string", "x-nullable": true }, "component_id": { "title": "Component id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "component": { "title": "Component", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimInventoryItemsId" }, "task": true }, { "name": "deleteDcimInventoryItemsId", "summary": "dcim_inventory-items_delete", "description": "dcim_inventory-items_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this inventory item.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimInventoryItemsId" }, "task": true }, { "name": "getDcimLocations", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "parent", "type": "string", "info": ": string", "required": false, "schema": { "title": "parent", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "parentN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "parent": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Planned", "Staging", "Active", "Decommissioning", "Retired" ] }, "value": { "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimLocations" }, "task": true }, { "name": "postDcimLocations", "summary": "dcim_locations_create", "description": "dcim_locations_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"site\": 123, \"parent\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123, \"device_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site": { "title": "Site", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimLocations" }, "task": true }, { "name": "putDcimLocations", "summary": "dcim_locations_bulk_update", "description": "dcim_locations_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"site\": 123, \"parent\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123, \"device_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site": { "title": "Site", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimLocations" }, "task": true }, { "name": "patchDcimLocations", "summary": "dcim_locations_bulk_partial_update", "description": "dcim_locations_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"site\": 123, \"parent\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123, \"device_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site": { "title": "Site", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimLocations" }, "task": true }, { "name": "deleteDcimLocations", "summary": "dcim_locations_bulk_delete", "description": "dcim_locations_bulk_delete", "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": "/deleteDcimLocations" }, "task": true }, { "name": "getDcimLocationsId", "summary": "dcim_locations_read", "description": "dcim_locations_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this location.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimLocationsId" }, "task": true }, { "name": "putDcimLocationsId", "summary": "dcim_locations_update", "description": "dcim_locations_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this location.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"site\": 123, \"parent\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123, \"device_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site": { "title": "Site", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimLocationsId" }, "task": true }, { "name": "patchDcimLocationsId", "summary": "dcim_locations_partial_update", "description": "dcim_locations_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this location.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"site\": 123, \"parent\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123, \"device_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site": { "title": "Site", "type": "integer" }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimLocationsId" }, "task": true }, { "name": "deleteDcimLocationsId", "summary": "dcim_locations_delete", "description": "dcim_locations_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this location.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimLocationsId" }, "task": true }, { "name": "getDcimManufacturers", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true }, "platform_count": { "title": "Platform count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimManufacturers" }, "task": true }, { "name": "postDcimManufacturers", "summary": "dcim_manufacturers_create", "description": "dcim_manufacturers_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"devicetype_count\": 123, \"inventoryitem_count\": 123, \"platform_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true }, "platform_count": { "title": "Platform count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimManufacturers" }, "task": true }, { "name": "putDcimManufacturers", "summary": "dcim_manufacturers_bulk_update", "description": "dcim_manufacturers_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"devicetype_count\": 123, \"inventoryitem_count\": 123, \"platform_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true }, "platform_count": { "title": "Platform count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimManufacturers" }, "task": true }, { "name": "patchDcimManufacturers", "summary": "dcim_manufacturers_bulk_partial_update", "description": "dcim_manufacturers_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"devicetype_count\": 123, \"inventoryitem_count\": 123, \"platform_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true }, "platform_count": { "title": "Platform count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimManufacturers" }, "task": true }, { "name": "deleteDcimManufacturers", "summary": "dcim_manufacturers_bulk_delete", "description": "dcim_manufacturers_bulk_delete", "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": "/deleteDcimManufacturers" }, "task": true }, { "name": "getDcimManufacturersId", "summary": "dcim_manufacturers_read", "description": "dcim_manufacturers_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this manufacturer.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimManufacturersId" }, "task": true }, { "name": "putDcimManufacturersId", "summary": "dcim_manufacturers_update", "description": "dcim_manufacturers_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this manufacturer.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"devicetype_count\": 123, \"inventoryitem_count\": 123, \"platform_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true }, "platform_count": { "title": "Platform count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimManufacturersId" }, "task": true }, { "name": "patchDcimManufacturersId", "summary": "dcim_manufacturers_partial_update", "description": "dcim_manufacturers_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this manufacturer.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"devicetype_count\": 123, \"inventoryitem_count\": 123, \"platform_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true }, "inventoryitem_count": { "title": "Inventoryitem count", "type": "integer", "readOnly": true }, "platform_count": { "title": "Platform count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimManufacturersId" }, "task": true }, { "name": "deleteDcimManufacturersId", "summary": "dcim_manufacturers_delete", "description": "dcim_manufacturers_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this manufacturer.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimManufacturersId" }, "task": true }, { "name": "getDcimModuleBayTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimModuleBayTemplates" }, "task": true }, { "name": "postDcimModuleBayTemplates", "summary": "dcim_module-bay-templates_create", "description": "dcim_module-bay-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimModuleBayTemplates" }, "task": true }, { "name": "putDcimModuleBayTemplates", "summary": "dcim_module-bay-templates_bulk_update", "description": "dcim_module-bay-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimModuleBayTemplates" }, "task": true }, { "name": "patchDcimModuleBayTemplates", "summary": "dcim_module-bay-templates_bulk_partial_update", "description": "dcim_module-bay-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimModuleBayTemplates" }, "task": true }, { "name": "deleteDcimModuleBayTemplates", "summary": "dcim_module-bay-templates_bulk_delete", "description": "dcim_module-bay-templates_bulk_delete", "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": "/deleteDcimModuleBayTemplates" }, "task": true }, { "name": "getDcimModuleBayTemplatesId", "summary": "dcim_module-bay-templates_read", "description": "dcim_module-bay-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module bay template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimModuleBayTemplatesId" }, "task": true }, { "name": "putDcimModuleBayTemplatesId", "summary": "dcim_module-bay-templates_update", "description": "dcim_module-bay-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module bay template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimModuleBayTemplatesId" }, "task": true }, { "name": "patchDcimModuleBayTemplatesId", "summary": "dcim_module-bay-templates_partial_update", "description": "dcim_module-bay-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module bay template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"name\": \"string\", \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer" }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimModuleBayTemplatesId" }, "task": true }, { "name": "deleteDcimModuleBayTemplatesId", "summary": "dcim_module-bay-templates_delete", "description": "dcim_module-bay-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module bay template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimModuleBayTemplatesId" }, "task": true }, { "name": "getDcimModuleBays", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "installed_module": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 } }, "x-nullable": true }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimModuleBays" }, "task": true }, { "name": "postDcimModuleBays", "summary": "dcim_module-bays_create", "description": "dcim_module-bays_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"installed_module\": 123, \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name", "installed_module" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "installed_module": { "title": "Installed module", "type": "integer" }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimModuleBays" }, "task": true }, { "name": "putDcimModuleBays", "summary": "dcim_module-bays_bulk_update", "description": "dcim_module-bays_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"installed_module\": 123, \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name", "installed_module" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "installed_module": { "title": "Installed module", "type": "integer" }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimModuleBays" }, "task": true }, { "name": "patchDcimModuleBays", "summary": "dcim_module-bays_bulk_partial_update", "description": "dcim_module-bays_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"installed_module\": 123, \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name", "installed_module" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "installed_module": { "title": "Installed module", "type": "integer" }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimModuleBays" }, "task": true }, { "name": "deleteDcimModuleBays", "summary": "dcim_module-bays_bulk_delete", "description": "dcim_module-bays_bulk_delete", "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": "/deleteDcimModuleBays" }, "task": true }, { "name": "getDcimModuleBaysId", "summary": "dcim_module-bays_read", "description": "dcim_module-bays_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module bay.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimModuleBaysId" }, "task": true }, { "name": "putDcimModuleBaysId", "summary": "dcim_module-bays_update", "description": "dcim_module-bays_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module bay.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"installed_module\": 123, \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name", "installed_module" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "installed_module": { "title": "Installed module", "type": "integer" }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimModuleBaysId" }, "task": true }, { "name": "patchDcimModuleBaysId", "summary": "dcim_module-bays_partial_update", "description": "dcim_module-bays_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module bay.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"name\": \"string\", \"installed_module\": 123, \"label\": \"string\", \"position\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "name", "installed_module" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "installed_module": { "title": "Installed module", "type": "integer" }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "position": { "title": "Position", "description": "Identifier to reference when renaming installed components", "type": "string", "maxLength": 30 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimModuleBaysId" }, "task": true }, { "name": "deleteDcimModuleBaysId", "summary": "dcim_module-bays_delete", "description": "dcim_module-bays_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module bay.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimModuleBaysId" }, "task": true }, { "name": "getDcimModuleTypes", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "model", "type": "string", "info": ": string", "required": false, "schema": { "title": "model", "type": "string" } }, { "name": "partNumber", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumber", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "manufacturerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerId", "type": "string" } }, { "name": "manufacturer", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturer", "type": "string" } }, { "name": "consolePorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "consolePorts", "type": "string" } }, { "name": "consoleServerPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "consoleServerPorts", "type": "string" } }, { "name": "powerPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "powerPorts", "type": "string" } }, { "name": "powerOutlets", "type": "string", "info": ": string", "required": false, "schema": { "title": "powerOutlets", "type": "string" } }, { "name": "interfaces", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaces", "type": "string" } }, { "name": "passThroughPorts", "type": "string", "info": ": string", "required": false, "schema": { "title": "passThroughPorts", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "modelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelN", "type": "string" } }, { "name": "modelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelIc", "type": "string" } }, { "name": "modelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelNic", "type": "string" } }, { "name": "modelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelIew", "type": "string" } }, { "name": "modelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelNiew", "type": "string" } }, { "name": "modelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelIsw", "type": "string" } }, { "name": "modelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelNisw", "type": "string" } }, { "name": "modelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelIe", "type": "string" } }, { "name": "modelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "modelNie", "type": "string" } }, { "name": "partNumberN", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberN", "type": "string" } }, { "name": "partNumberIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberIc", "type": "string" } }, { "name": "partNumberNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberNic", "type": "string" } }, { "name": "partNumberIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberIew", "type": "string" } }, { "name": "partNumberNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberNiew", "type": "string" } }, { "name": "partNumberIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberIsw", "type": "string" } }, { "name": "partNumberNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberNisw", "type": "string" } }, { "name": "partNumberIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberIe", "type": "string" } }, { "name": "partNumberNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "partNumberNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "manufacturerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerIdN", "type": "string" } }, { "name": "manufacturerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "manufacturer", "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimModuleTypes" }, "task": true }, { "name": "postDcimModuleTypes", "summary": "dcim_module-types_create", "description": "dcim_module-types_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"part_number\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "manufacturer", "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimModuleTypes" }, "task": true }, { "name": "putDcimModuleTypes", "summary": "dcim_module-types_bulk_update", "description": "dcim_module-types_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"part_number\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "manufacturer", "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimModuleTypes" }, "task": true }, { "name": "patchDcimModuleTypes", "summary": "dcim_module-types_bulk_partial_update", "description": "dcim_module-types_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"part_number\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "manufacturer", "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimModuleTypes" }, "task": true }, { "name": "deleteDcimModuleTypes", "summary": "dcim_module-types_bulk_delete", "description": "dcim_module-types_bulk_delete", "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": "/deleteDcimModuleTypes" }, "task": true }, { "name": "getDcimModuleTypesId", "summary": "dcim_module-types_read", "description": "dcim_module-types_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module type.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimModuleTypesId" }, "task": true }, { "name": "putDcimModuleTypesId", "summary": "dcim_module-types_update", "description": "dcim_module-types_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module type.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"part_number\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "manufacturer", "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimModuleTypesId" }, "task": true }, { "name": "patchDcimModuleTypesId", "summary": "dcim_module-types_partial_update", "description": "dcim_module-types_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module type.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"manufacturer\": 123, \"model\": \"string\", \"part_number\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "manufacturer", "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "title": "Manufacturer", "type": "integer" }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "part_number": { "title": "Part number", "description": "Discrete part number (optional)", "type": "string", "maxLength": 50 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimModuleTypesId" }, "task": true }, { "name": "deleteDcimModuleTypesId", "summary": "dcim_module-types_delete", "description": "dcim_module-types_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module type.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimModuleTypesId" }, "task": true }, { "name": "getDcimModules", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "assetTag", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTag", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "manufacturerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerId", "type": "string" } }, { "name": "manufacturer", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturer", "type": "string" } }, { "name": "moduleTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleTypeId", "type": "string" } }, { "name": "moduleType", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleType", "type": "string" } }, { "name": "moduleBayId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleBayId", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "serial", "type": "string", "info": ": string", "required": false, "schema": { "title": "serial", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "assetTagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagN", "type": "string" } }, { "name": "assetTagIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIc", "type": "string" } }, { "name": "assetTagNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNic", "type": "string" } }, { "name": "assetTagIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIew", "type": "string" } }, { "name": "assetTagNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNiew", "type": "string" } }, { "name": "assetTagIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIsw", "type": "string" } }, { "name": "assetTagNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNisw", "type": "string" } }, { "name": "assetTagIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIe", "type": "string" } }, { "name": "assetTagNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "manufacturerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerIdN", "type": "string" } }, { "name": "manufacturerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerN", "type": "string" } }, { "name": "moduleTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleTypeIdN", "type": "string" } }, { "name": "moduleTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleTypeN", "type": "string" } }, { "name": "moduleBayIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleBayIdN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "serialN", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialN", "type": "string" } }, { "name": "serialIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIc", "type": "string" } }, { "name": "serialNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNic", "type": "string" } }, { "name": "serialIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIew", "type": "string" } }, { "name": "serialNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNiew", "type": "string" } }, { "name": "serialIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIsw", "type": "string" } }, { "name": "serialNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNisw", "type": "string" } }, { "name": "serialIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIe", "type": "string" } }, { "name": "serialNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNie", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "module_bay", "module_type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "module": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimModules" }, "task": true }, { "name": "postDcimModules", "summary": "dcim_modules_create", "description": "dcim_modules_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module_bay\": 123, \"module_type\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "module_bay", "module_type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "title": "Module bay", "type": "integer" }, "module_type": { "title": "Module type", "type": "integer" }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimModules" }, "task": true }, { "name": "putDcimModules", "summary": "dcim_modules_bulk_update", "description": "dcim_modules_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module_bay\": 123, \"module_type\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "module_bay", "module_type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "title": "Module bay", "type": "integer" }, "module_type": { "title": "Module type", "type": "integer" }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimModules" }, "task": true }, { "name": "patchDcimModules", "summary": "dcim_modules_bulk_partial_update", "description": "dcim_modules_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module_bay\": 123, \"module_type\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "module_bay", "module_type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "title": "Module bay", "type": "integer" }, "module_type": { "title": "Module type", "type": "integer" }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimModules" }, "task": true }, { "name": "deleteDcimModules", "summary": "dcim_modules_bulk_delete", "description": "dcim_modules_bulk_delete", "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": "/deleteDcimModules" }, "task": true }, { "name": "getDcimModulesId", "summary": "dcim_modules_read", "description": "dcim_modules_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimModulesId" }, "task": true }, { "name": "putDcimModulesId", "summary": "dcim_modules_update", "description": "dcim_modules_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module_bay\": 123, \"module_type\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "module_bay", "module_type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "title": "Module bay", "type": "integer" }, "module_type": { "title": "Module type", "type": "integer" }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimModulesId" }, "task": true }, { "name": "patchDcimModulesId", "summary": "dcim_modules_partial_update", "description": "dcim_modules_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module_bay\": 123, \"module_type\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device", "module_bay", "module_type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "title": "Module bay", "type": "integer" }, "module_type": { "title": "Module type", "type": "integer" }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this device", "type": "string", "maxLength": 50, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimModulesId" }, "task": true }, { "name": "deleteDcimModulesId", "summary": "dcim_modules_delete", "description": "dcim_modules_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this module.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimModulesId" }, "task": true }, { "name": "getDcimPlatforms", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "napalmDriver", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriver", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "manufacturerId", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerId", "type": "string" } }, { "name": "manufacturer", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturer", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "napalmDriverN", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverN", "type": "string" } }, { "name": "napalmDriverIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverIc", "type": "string" } }, { "name": "napalmDriverNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverNic", "type": "string" } }, { "name": "napalmDriverIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverIew", "type": "string" } }, { "name": "napalmDriverNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverNiew", "type": "string" } }, { "name": "napalmDriverIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverIsw", "type": "string" } }, { "name": "napalmDriverNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverNisw", "type": "string" } }, { "name": "napalmDriverIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverIe", "type": "string" } }, { "name": "napalmDriverNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "napalmDriverNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "manufacturerIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerIdN", "type": "string" } }, { "name": "manufacturerN", "type": "string", "info": ": string", "required": false, "schema": { "title": "manufacturerN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "napalm_driver": { "title": "NAPALM driver", "description": "The name of the NAPALM driver to use when interacting with devices", "type": "string", "maxLength": 50 }, "napalm_args": { "title": "NAPALM arguments", "description": "Additional arguments to pass when initiating the NAPALM driver (JSON format)", "type": "object", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimPlatforms" }, "task": true }, { "name": "postDcimPlatforms", "summary": "dcim_platforms_create", "description": "dcim_platforms_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"manufacturer\": 123, \"napalm_driver\": \"string\", \"napalm_args\": \"object\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "manufacturer": { "title": "Manufacturer", "description": "Optionally limit this platform to devices of a certain manufacturer", "type": "integer", "x-nullable": true }, "napalm_driver": { "title": "NAPALM driver", "description": "The name of the NAPALM driver to use when interacting with devices", "type": "string", "maxLength": 50 }, "napalm_args": { "title": "NAPALM arguments", "description": "Additional arguments to pass when initiating the NAPALM driver (JSON format)", "type": "object", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimPlatforms" }, "task": true }, { "name": "putDcimPlatforms", "summary": "dcim_platforms_bulk_update", "description": "dcim_platforms_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"manufacturer\": 123, \"napalm_driver\": \"string\", \"napalm_args\": \"object\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "manufacturer": { "title": "Manufacturer", "description": "Optionally limit this platform to devices of a certain manufacturer", "type": "integer", "x-nullable": true }, "napalm_driver": { "title": "NAPALM driver", "description": "The name of the NAPALM driver to use when interacting with devices", "type": "string", "maxLength": 50 }, "napalm_args": { "title": "NAPALM arguments", "description": "Additional arguments to pass when initiating the NAPALM driver (JSON format)", "type": "object", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPlatforms" }, "task": true }, { "name": "patchDcimPlatforms", "summary": "dcim_platforms_bulk_partial_update", "description": "dcim_platforms_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"manufacturer\": 123, \"napalm_driver\": \"string\", \"napalm_args\": \"object\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "manufacturer": { "title": "Manufacturer", "description": "Optionally limit this platform to devices of a certain manufacturer", "type": "integer", "x-nullable": true }, "napalm_driver": { "title": "NAPALM driver", "description": "The name of the NAPALM driver to use when interacting with devices", "type": "string", "maxLength": 50 }, "napalm_args": { "title": "NAPALM arguments", "description": "Additional arguments to pass when initiating the NAPALM driver (JSON format)", "type": "object", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPlatforms" }, "task": true }, { "name": "deleteDcimPlatforms", "summary": "dcim_platforms_bulk_delete", "description": "dcim_platforms_bulk_delete", "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": "/deleteDcimPlatforms" }, "task": true }, { "name": "getDcimPlatformsId", "summary": "dcim_platforms_read", "description": "dcim_platforms_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this platform.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPlatformsId" }, "task": true }, { "name": "putDcimPlatformsId", "summary": "dcim_platforms_update", "description": "dcim_platforms_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this platform.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"manufacturer\": 123, \"napalm_driver\": \"string\", \"napalm_args\": \"object\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "manufacturer": { "title": "Manufacturer", "description": "Optionally limit this platform to devices of a certain manufacturer", "type": "integer", "x-nullable": true }, "napalm_driver": { "title": "NAPALM driver", "description": "The name of the NAPALM driver to use when interacting with devices", "type": "string", "maxLength": 50 }, "napalm_args": { "title": "NAPALM arguments", "description": "Additional arguments to pass when initiating the NAPALM driver (JSON format)", "type": "object", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPlatformsId" }, "task": true }, { "name": "patchDcimPlatformsId", "summary": "dcim_platforms_partial_update", "description": "dcim_platforms_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this platform.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"manufacturer\": 123, \"napalm_driver\": \"string\", \"napalm_args\": \"object\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "manufacturer": { "title": "Manufacturer", "description": "Optionally limit this platform to devices of a certain manufacturer", "type": "integer", "x-nullable": true }, "napalm_driver": { "title": "NAPALM driver", "description": "The name of the NAPALM driver to use when interacting with devices", "type": "string", "maxLength": 50 }, "napalm_args": { "title": "NAPALM arguments", "description": "Additional arguments to pass when initiating the NAPALM driver (JSON format)", "type": "object", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPlatformsId" }, "task": true }, { "name": "deleteDcimPlatformsId", "summary": "dcim_platforms_delete", "description": "dcim_platforms_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this platform.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimPlatformsId" }, "task": true }, { "name": "getDcimPowerFeeds", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "supply", "type": "string", "info": ": string", "required": false, "schema": { "title": "supply", "type": "string" } }, { "name": "phase", "type": "string", "info": ": string", "required": false, "schema": { "title": "phase", "type": "string" } }, { "name": "voltage", "type": "string", "info": ": string", "required": false, "schema": { "title": "voltage", "type": "string" } }, { "name": "amperage", "type": "string", "info": ": string", "required": false, "schema": { "title": "amperage", "type": "string" } }, { "name": "maxUtilization", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxUtilization", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "connected", "type": "string", "info": ": string", "required": false, "schema": { "title": "connected", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "powerPanelId", "type": "string", "info": ": string", "required": false, "schema": { "title": "powerPanelId", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "supplyN", "type": "string", "info": ": string", "required": false, "schema": { "title": "supplyN", "type": "string" } }, { "name": "phaseN", "type": "string", "info": ": string", "required": false, "schema": { "title": "phaseN", "type": "string" } }, { "name": "voltageN", "type": "string", "info": ": string", "required": false, "schema": { "title": "voltageN", "type": "string" } }, { "name": "voltageLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "voltageLte", "type": "string" } }, { "name": "voltageLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "voltageLt", "type": "string" } }, { "name": "voltageGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "voltageGte", "type": "string" } }, { "name": "voltageGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "voltageGt", "type": "string" } }, { "name": "amperageN", "type": "string", "info": ": string", "required": false, "schema": { "title": "amperageN", "type": "string" } }, { "name": "amperageLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "amperageLte", "type": "string" } }, { "name": "amperageLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "amperageLt", "type": "string" } }, { "name": "amperageGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "amperageGte", "type": "string" } }, { "name": "amperageGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "amperageGt", "type": "string" } }, { "name": "maxUtilizationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxUtilizationN", "type": "string" } }, { "name": "maxUtilizationLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxUtilizationLte", "type": "string" } }, { "name": "maxUtilizationLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxUtilizationLt", "type": "string" } }, { "name": "maxUtilizationGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxUtilizationGte", "type": "string" } }, { "name": "maxUtilizationGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxUtilizationGt", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "powerPanelIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "powerPanelIdN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "power_panel", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "power_panel": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true } } }, "rack": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Offline", "Active", "Planned", "Failed" ] }, "value": { "type": "string", "enum": [ "offline", "active", "planned", "failed" ] } }, "default": { "value": "active", "label": "Active" } }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Primary", "Redundant" ] }, "value": { "type": "string", "enum": [ "primary", "redundant" ] } }, "default": { "value": "primary", "label": "Primary" } }, "supply": { "title": "Supply", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "AC", "DC" ] }, "value": { "type": "string", "enum": [ "ac", "dc" ] } }, "default": { "value": "ac", "label": "AC" } }, "phase": { "title": "Phase", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Single phase", "Three-phase" ] }, "value": { "type": "string", "enum": [ "single-phase", "three-phase" ] } }, "default": { "value": "single-phase", "label": "Single phase" } }, "voltage": { "title": "Voltage", "type": "integer", "maximum": 32767, "minimum": -32768 }, "amperage": { "title": "Amperage", "type": "integer", "maximum": 32767, "minimum": 1 }, "max_utilization": { "title": "Max utilization", "description": "Maximum permissible draw (percentage)", "type": "integer", "maximum": 100, "minimum": 1 }, "comments": { "title": "Comments", "type": "string" }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimPowerFeeds" }, "task": true }, { "name": "postDcimPowerFeeds", "summary": "dcim_power-feeds_create", "description": "dcim_power-feeds_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"power_panel\": 123, \"rack\": 123, \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, failed]\", \"type\": \"Must be one of [primary, redundant]\", \"supply\": \"Must be one of [ac, dc]\", \"phase\": \"Must be one of [single-phase, three-phase]\", \"voltage\": 123, \"amperage\": 123, \"max_utilization\": 123, \"comments\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "power_panel", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "power_panel": { "title": "Power panel", "type": "integer" }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "failed" ] }, "type": { "title": "Type", "type": "string", "enum": [ "primary", "redundant" ] }, "supply": { "title": "Supply", "type": "string", "enum": [ "ac", "dc" ] }, "phase": { "title": "Phase", "type": "string", "enum": [ "single-phase", "three-phase" ] }, "voltage": { "title": "Voltage", "type": "integer", "maximum": 32767, "minimum": -32768 }, "amperage": { "title": "Amperage", "type": "integer", "maximum": 32767, "minimum": 1 }, "max_utilization": { "title": "Max utilization", "description": "Maximum permissible draw (percentage)", "type": "integer", "maximum": 100, "minimum": 1 }, "comments": { "title": "Comments", "type": "string" }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimPowerFeeds" }, "task": true }, { "name": "putDcimPowerFeeds", "summary": "dcim_power-feeds_bulk_update", "description": "dcim_power-feeds_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"power_panel\": 123, \"rack\": 123, \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, failed]\", \"type\": \"Must be one of [primary, redundant]\", \"supply\": \"Must be one of [ac, dc]\", \"phase\": \"Must be one of [single-phase, three-phase]\", \"voltage\": 123, \"amperage\": 123, \"max_utilization\": 123, \"comments\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "power_panel", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "power_panel": { "title": "Power panel", "type": "integer" }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "failed" ] }, "type": { "title": "Type", "type": "string", "enum": [ "primary", "redundant" ] }, "supply": { "title": "Supply", "type": "string", "enum": [ "ac", "dc" ] }, "phase": { "title": "Phase", "type": "string", "enum": [ "single-phase", "three-phase" ] }, "voltage": { "title": "Voltage", "type": "integer", "maximum": 32767, "minimum": -32768 }, "amperage": { "title": "Amperage", "type": "integer", "maximum": 32767, "minimum": 1 }, "max_utilization": { "title": "Max utilization", "description": "Maximum permissible draw (percentage)", "type": "integer", "maximum": 100, "minimum": 1 }, "comments": { "title": "Comments", "type": "string" }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerFeeds" }, "task": true }, { "name": "patchDcimPowerFeeds", "summary": "dcim_power-feeds_bulk_partial_update", "description": "dcim_power-feeds_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"power_panel\": 123, \"rack\": 123, \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, failed]\", \"type\": \"Must be one of [primary, redundant]\", \"supply\": \"Must be one of [ac, dc]\", \"phase\": \"Must be one of [single-phase, three-phase]\", \"voltage\": 123, \"amperage\": 123, \"max_utilization\": 123, \"comments\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "power_panel", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "power_panel": { "title": "Power panel", "type": "integer" }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "failed" ] }, "type": { "title": "Type", "type": "string", "enum": [ "primary", "redundant" ] }, "supply": { "title": "Supply", "type": "string", "enum": [ "ac", "dc" ] }, "phase": { "title": "Phase", "type": "string", "enum": [ "single-phase", "three-phase" ] }, "voltage": { "title": "Voltage", "type": "integer", "maximum": 32767, "minimum": -32768 }, "amperage": { "title": "Amperage", "type": "integer", "maximum": 32767, "minimum": 1 }, "max_utilization": { "title": "Max utilization", "description": "Maximum permissible draw (percentage)", "type": "integer", "maximum": 100, "minimum": 1 }, "comments": { "title": "Comments", "type": "string" }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerFeeds" }, "task": true }, { "name": "deleteDcimPowerFeeds", "summary": "dcim_power-feeds_bulk_delete", "description": "dcim_power-feeds_bulk_delete", "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": "/deleteDcimPowerFeeds" }, "task": true }, { "name": "getDcimPowerFeedsId", "summary": "dcim_power-feeds_read", "description": "dcim_power-feeds_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power feed.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerFeedsId" }, "task": true }, { "name": "putDcimPowerFeedsId", "summary": "dcim_power-feeds_update", "description": "dcim_power-feeds_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power feed.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"power_panel\": 123, \"rack\": 123, \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, failed]\", \"type\": \"Must be one of [primary, redundant]\", \"supply\": \"Must be one of [ac, dc]\", \"phase\": \"Must be one of [single-phase, three-phase]\", \"voltage\": 123, \"amperage\": 123, \"max_utilization\": 123, \"comments\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "power_panel", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "power_panel": { "title": "Power panel", "type": "integer" }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "failed" ] }, "type": { "title": "Type", "type": "string", "enum": [ "primary", "redundant" ] }, "supply": { "title": "Supply", "type": "string", "enum": [ "ac", "dc" ] }, "phase": { "title": "Phase", "type": "string", "enum": [ "single-phase", "three-phase" ] }, "voltage": { "title": "Voltage", "type": "integer", "maximum": 32767, "minimum": -32768 }, "amperage": { "title": "Amperage", "type": "integer", "maximum": 32767, "minimum": 1 }, "max_utilization": { "title": "Max utilization", "description": "Maximum permissible draw (percentage)", "type": "integer", "maximum": 100, "minimum": 1 }, "comments": { "title": "Comments", "type": "string" }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerFeedsId" }, "task": true }, { "name": "patchDcimPowerFeedsId", "summary": "dcim_power-feeds_partial_update", "description": "dcim_power-feeds_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power feed.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"power_panel\": 123, \"rack\": 123, \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, failed]\", \"type\": \"Must be one of [primary, redundant]\", \"supply\": \"Must be one of [ac, dc]\", \"phase\": \"Must be one of [single-phase, three-phase]\", \"voltage\": 123, \"amperage\": 123, \"max_utilization\": 123, \"comments\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "power_panel", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "power_panel": { "title": "Power panel", "type": "integer" }, "rack": { "title": "Rack", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "failed" ] }, "type": { "title": "Type", "type": "string", "enum": [ "primary", "redundant" ] }, "supply": { "title": "Supply", "type": "string", "enum": [ "ac", "dc" ] }, "phase": { "title": "Phase", "type": "string", "enum": [ "single-phase", "three-phase" ] }, "voltage": { "title": "Voltage", "type": "integer", "maximum": 32767, "minimum": -32768 }, "amperage": { "title": "Amperage", "type": "integer", "maximum": 32767, "minimum": 1 }, "max_utilization": { "title": "Max utilization", "description": "Maximum permissible draw (percentage)", "type": "integer", "maximum": 100, "minimum": 1 }, "comments": { "title": "Comments", "type": "string" }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerFeedsId" }, "task": true }, { "name": "deleteDcimPowerFeedsId", "summary": "dcim_power-feeds_delete", "description": "dcim_power-feeds_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power feed.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimPowerFeedsId" }, "task": true }, { "name": "getDcimPowerFeedsIdTrace", "summary": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin", "description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power feed.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerFeedsIdTrace" }, "task": true }, { "name": "getDcimPowerOutletTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "feedLeg", "type": "string", "info": ": string", "required": false, "schema": { "title": "feedLeg", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "moduletypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "feedLegN", "type": "string", "info": ": string", "required": false, "schema": { "title": "feedLegN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "moduletypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "C5", "C7", "C13", "C15", "C19", "C21", "P+N+E 4H", "P+N+E 6H", "P+N+E 9H", "2P+E 4H", "2P+E 6H", "2P+E 9H", "3P+E 4H", "3P+E 6H", "3P+E 9H", "3P+N+E 4H", "3P+N+E 6H", "3P+N+E 9H", "NEMA 1-15R", "NEMA 5-15R", "NEMA 5-20R", "NEMA 5-30R", "NEMA 5-50R", "NEMA 6-15R", "NEMA 6-20R", "NEMA 6-30R", "NEMA 6-50R", "NEMA 10-30R", "NEMA 10-50R", "NEMA 14-20R", "NEMA 14-30R", "NEMA 14-50R", "NEMA 14-60R", "NEMA 15-15R", "NEMA 15-20R", "NEMA 15-30R", "NEMA 15-50R", "NEMA 15-60R", "NEMA L1-15R", "NEMA L5-15R", "NEMA L5-20R", "NEMA L5-30R", "NEMA L5-50R", "NEMA L6-15R", "NEMA L6-20R", "NEMA L6-30R", "NEMA L6-50R", "NEMA L10-30R", "NEMA L14-20R", "NEMA L14-30R", "NEMA L14-50R", "NEMA L14-60R", "NEMA L15-20R", "NEMA L15-30R", "NEMA L15-50R", "NEMA L15-60R", "NEMA L21-20R", "NEMA L21-30R", "NEMA L22-30R", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ITA Type E (CEE 7/5)", "ITA Type F (CEE 7/3)", "ITA Type G (BS 1363)", "ITA Type H", "ITA Type I", "ITA Type J", "ITA Type K", "ITA Type L (CEI 23-50)", "ITA Type M (BS 546)", "ITA Type N", "ITA Type O", "ITA Multistandard", "USB Type A", "USB Micro B", "USB Type C", "DC Terminal", "HDOT Cx", "Saf-D-Grid", "Neutrik powerCON (20A)", "Neutrik powerCON (32A)", "Neutrik powerCON TRUE1", "Neutrik powerCON TRUE1 TOP", "Ubiquiti SmartPower", "Hardwired", "Other" ] }, "value": { "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] } } }, "power_port": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "feed_leg": { "title": "Feed leg", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "A", "B", "C" ] }, "value": { "type": "string", "enum": [ "A", "B", "C" ] } } }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimPowerOutletTemplates" }, "task": true }, { "name": "postDcimPowerOutletTemplates", "summary": "dcim_power-outlet-templates_create", "description": "dcim_power-outlet-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimPowerOutletTemplates" }, "task": true }, { "name": "putDcimPowerOutletTemplates", "summary": "dcim_power-outlet-templates_bulk_update", "description": "dcim_power-outlet-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerOutletTemplates" }, "task": true }, { "name": "patchDcimPowerOutletTemplates", "summary": "dcim_power-outlet-templates_bulk_partial_update", "description": "dcim_power-outlet-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerOutletTemplates" }, "task": true }, { "name": "deleteDcimPowerOutletTemplates", "summary": "dcim_power-outlet-templates_bulk_delete", "description": "dcim_power-outlet-templates_bulk_delete", "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": "/deleteDcimPowerOutletTemplates" }, "task": true }, { "name": "getDcimPowerOutletTemplatesId", "summary": "dcim_power-outlet-templates_read", "description": "dcim_power-outlet-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerOutletTemplatesId" }, "task": true }, { "name": "putDcimPowerOutletTemplatesId", "summary": "dcim_power-outlet-templates_update", "description": "dcim_power-outlet-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerOutletTemplatesId" }, "task": true }, { "name": "patchDcimPowerOutletTemplatesId", "summary": "dcim_power-outlet-templates_partial_update", "description": "dcim_power-outlet-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerOutletTemplatesId" }, "task": true }, { "name": "deleteDcimPowerOutletTemplatesId", "summary": "dcim_power-outlet-templates_delete", "description": "dcim_power-outlet-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimPowerOutletTemplatesId" }, "task": true }, { "name": "getDcimPowerOutlets", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "feedLeg", "type": "string", "info": ": string", "required": false, "schema": { "title": "feedLeg", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "moduleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "connected", "type": "string", "info": ": string", "required": false, "schema": { "title": "connected", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "feedLegN", "type": "string", "info": ": string", "required": false, "schema": { "title": "feedLegN", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "moduleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleIdN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module": { "required": [ "device" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "C5", "C7", "C13", "C15", "C19", "C21", "P+N+E 4H", "P+N+E 6H", "P+N+E 9H", "2P+E 4H", "2P+E 6H", "2P+E 9H", "3P+E 4H", "3P+E 6H", "3P+E 9H", "3P+N+E 4H", "3P+N+E 6H", "3P+N+E 9H", "NEMA 1-15R", "NEMA 5-15R", "NEMA 5-20R", "NEMA 5-30R", "NEMA 5-50R", "NEMA 6-15R", "NEMA 6-20R", "NEMA 6-30R", "NEMA 6-50R", "NEMA 10-30R", "NEMA 10-50R", "NEMA 14-20R", "NEMA 14-30R", "NEMA 14-50R", "NEMA 14-60R", "NEMA 15-15R", "NEMA 15-20R", "NEMA 15-30R", "NEMA 15-50R", "NEMA 15-60R", "NEMA L1-15R", "NEMA L5-15R", "NEMA L5-20R", "NEMA L5-30R", "NEMA L5-50R", "NEMA L6-15R", "NEMA L6-20R", "NEMA L6-30R", "NEMA L6-50R", "NEMA L10-30R", "NEMA L14-20R", "NEMA L14-30R", "NEMA L14-50R", "NEMA L14-60R", "NEMA L15-20R", "NEMA L15-30R", "NEMA L15-50R", "NEMA L15-60R", "NEMA L21-20R", "NEMA L21-30R", "NEMA L22-30R", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ITA Type E (CEE 7/5)", "ITA Type F (CEE 7/3)", "ITA Type G (BS 1363)", "ITA Type H", "ITA Type I", "ITA Type J", "ITA Type K", "ITA Type L (CEI 23-50)", "ITA Type M (BS 546)", "ITA Type N", "ITA Type O", "ITA Multistandard", "USB Type A", "USB Micro B", "USB Type C", "DC Terminal", "HDOT Cx", "Saf-D-Grid", "Neutrik powerCON (20A)", "Neutrik powerCON (32A)", "Neutrik powerCON TRUE1", "Neutrik powerCON TRUE1 TOP", "Ubiquiti SmartPower", "Hardwired", "Other" ] }, "value": { "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] } } }, "power_port": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "cable": { "title": "Cable", "type": "integer", "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "x-nullable": true }, "feed_leg": { "title": "Feed leg", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "A", "B", "C" ] }, "value": { "type": "string", "enum": [ "A", "B", "C" ] } } }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimPowerOutlets" }, "task": true }, { "name": "postDcimPowerOutlets", "summary": "dcim_power-outlets_create", "description": "dcim_power-outlets_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimPowerOutlets" }, "task": true }, { "name": "putDcimPowerOutlets", "summary": "dcim_power-outlets_bulk_update", "description": "dcim_power-outlets_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerOutlets" }, "task": true }, { "name": "patchDcimPowerOutlets", "summary": "dcim_power-outlets_bulk_partial_update", "description": "dcim_power-outlets_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerOutlets" }, "task": true }, { "name": "deleteDcimPowerOutlets", "summary": "dcim_power-outlets_bulk_delete", "description": "dcim_power-outlets_bulk_delete", "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": "/deleteDcimPowerOutlets" }, "task": true }, { "name": "getDcimPowerOutletsId", "summary": "dcim_power-outlets_read", "description": "dcim_power-outlets_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerOutletsId" }, "task": true }, { "name": "putDcimPowerOutletsId", "summary": "dcim_power-outlets_update", "description": "dcim_power-outlets_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerOutletsId" }, "task": true }, { "name": "patchDcimPowerOutletsId", "summary": "dcim_power-outlets_partial_update", "description": "dcim_power-outlets_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c5, iec-60320-c7, iec-60320-c13, iec-60320-c15, iec-60320-c19, iec-60320-c21, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15r, nema-5-15r, nema-5-20r, nema-5-30r, nema-5-50r, nema-6-15r, nema-6-20r, nema-6-30r, nema-6-50r, nema-10-30r, nema-10-50r, nema-14-20r, nema-14-30r, nema-14-50r, nema-14-60r, nema-15-15r, nema-15-20r, nema-15-30r, nema-15-50r, nema-15-60r, nema-l1-15r, nema-l5-15r, nema-l5-20r, nema-l5-30r, nema-l5-50r, nema-l6-15r, nema-l6-20r, nema-l6-30r, nema-l6-50r, nema-l10-30r, nema-l14-20r, nema-l14-30r, nema-l14-50r, nema-l14-60r, nema-l15-20r, nema-l15-30r, nema-l15-50r, nema-l15-60r, nema-l21-20r, nema-l21-30r, nema-l22-30r, CS6360C, CS6364C, CS8164C, CS8264C, CS8364C, CS8464C, ita-e, ita-f, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, ita-multistandard, usb-a, usb-micro-b, usb-c, dc-terminal, hdot-cx, saf-d-grid, neutrik-powercon-20a, neutrik-powercon-32a, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"power_port\": 123, \"feed_leg\": \"Must be one of [A, B, C]\", \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c5", "iec-60320-c7", "iec-60320-c13", "iec-60320-c15", "iec-60320-c19", "iec-60320-c21", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15r", "nema-5-15r", "nema-5-20r", "nema-5-30r", "nema-5-50r", "nema-6-15r", "nema-6-20r", "nema-6-30r", "nema-6-50r", "nema-10-30r", "nema-10-50r", "nema-14-20r", "nema-14-30r", "nema-14-50r", "nema-14-60r", "nema-15-15r", "nema-15-20r", "nema-15-30r", "nema-15-50r", "nema-15-60r", "nema-l1-15r", "nema-l5-15r", "nema-l5-20r", "nema-l5-30r", "nema-l5-50r", "nema-l6-15r", "nema-l6-20r", "nema-l6-30r", "nema-l6-50r", "nema-l10-30r", "nema-l14-20r", "nema-l14-30r", "nema-l14-50r", "nema-l14-60r", "nema-l15-20r", "nema-l15-30r", "nema-l15-50r", "nema-l15-60r", "nema-l21-20r", "nema-l21-30r", "nema-l22-30r", "CS6360C", "CS6364C", "CS8164C", "CS8264C", "CS8364C", "CS8464C", "ita-e", "ita-f", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "ita-multistandard", "usb-a", "usb-micro-b", "usb-c", "dc-terminal", "hdot-cx", "saf-d-grid", "neutrik-powercon-20a", "neutrik-powercon-32a", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "power_port": { "title": "Power port", "type": "integer", "x-nullable": true }, "feed_leg": { "title": "Feed leg", "description": "Phase (for three-phase feeds)", "type": "string", "enum": [ "A", "B", "C" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerOutletsId" }, "task": true }, { "name": "deleteDcimPowerOutletsId", "summary": "dcim_power-outlets_delete", "description": "dcim_power-outlets_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimPowerOutletsId" }, "task": true }, { "name": "getDcimPowerOutletsIdTrace", "summary": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin", "description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power outlet.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerOutletsIdTrace" }, "task": true }, { "name": "getDcimPowerPanels", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "site", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "location": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimPowerPanels" }, "task": true }, { "name": "postDcimPowerPanels", "summary": "dcim_power-panels_create", "description": "dcim_power-panels_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"location\": 123, \"name\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"powerfeed_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "site", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimPowerPanels" }, "task": true }, { "name": "putDcimPowerPanels", "summary": "dcim_power-panels_bulk_update", "description": "dcim_power-panels_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"location\": 123, \"name\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"powerfeed_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "site", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerPanels" }, "task": true }, { "name": "patchDcimPowerPanels", "summary": "dcim_power-panels_bulk_partial_update", "description": "dcim_power-panels_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"location\": 123, \"name\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"powerfeed_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "site", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerPanels" }, "task": true }, { "name": "deleteDcimPowerPanels", "summary": "dcim_power-panels_bulk_delete", "description": "dcim_power-panels_bulk_delete", "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": "/deleteDcimPowerPanels" }, "task": true }, { "name": "getDcimPowerPanelsId", "summary": "dcim_power-panels_read", "description": "dcim_power-panels_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power panel.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerPanelsId" }, "task": true }, { "name": "putDcimPowerPanelsId", "summary": "dcim_power-panels_update", "description": "dcim_power-panels_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power panel.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"location\": 123, \"name\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"powerfeed_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "site", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerPanelsId" }, "task": true }, { "name": "patchDcimPowerPanelsId", "summary": "dcim_power-panels_partial_update", "description": "dcim_power-panels_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power panel.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"location\": 123, \"name\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"powerfeed_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "site", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerPanelsId" }, "task": true }, { "name": "deleteDcimPowerPanelsId", "summary": "dcim_power-panels_delete", "description": "dcim_power-panels_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power panel.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimPowerPanelsId" }, "task": true }, { "name": "getDcimPowerPortTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "maximumDraw", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDraw", "type": "string" } }, { "name": "allocatedDraw", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDraw", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "moduletypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "maximumDrawN", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawN", "type": "string" } }, { "name": "maximumDrawLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawLte", "type": "string" } }, { "name": "maximumDrawLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawLt", "type": "string" } }, { "name": "maximumDrawGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawGte", "type": "string" } }, { "name": "maximumDrawGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawGt", "type": "string" } }, { "name": "allocatedDrawN", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawN", "type": "string" } }, { "name": "allocatedDrawLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawLte", "type": "string" } }, { "name": "allocatedDrawLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawLt", "type": "string" } }, { "name": "allocatedDrawGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawGte", "type": "string" } }, { "name": "allocatedDrawGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawGt", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "moduletypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "C6", "C8", "C14", "C16", "C20", "C22", "P+N+E 4H", "P+N+E 6H", "P+N+E 9H", "2P+E 4H", "2P+E 6H", "2P+E 9H", "3P+E 4H", "3P+E 6H", "3P+E 9H", "3P+N+E 4H", "3P+N+E 6H", "3P+N+E 9H", "NEMA 1-15P", "NEMA 5-15P", "NEMA 5-20P", "NEMA 5-30P", "NEMA 5-50P", "NEMA 6-15P", "NEMA 6-20P", "NEMA 6-30P", "NEMA 6-50P", "NEMA 10-30P", "NEMA 10-50P", "NEMA 14-20P", "NEMA 14-30P", "NEMA 14-50P", "NEMA 14-60P", "NEMA 15-15P", "NEMA 15-20P", "NEMA 15-30P", "NEMA 15-50P", "NEMA 15-60P", "NEMA L1-15P", "NEMA L5-15P", "NEMA L5-20P", "NEMA L5-30P", "NEMA L5-50P", "NEMA L6-15P", "NEMA L6-20P", "NEMA L6-30P", "NEMA L6-50P", "NEMA L10-30P", "NEMA L14-20P", "NEMA L14-30P", "NEMA L14-50P", "NEMA L14-60P", "NEMA L15-20P", "NEMA L15-30P", "NEMA L15-50P", "NEMA L15-60P", "NEMA L21-20P", "NEMA L21-30P", "NEMA L22-30P", "CS6361C", "CS6365C", "CS8165C", "CS8265C", "CS8365C", "CS8465C", "ITA Type C (CEE 7/16)", "ITA Type E (CEE 7/6)", "ITA Type F (CEE 7/4)", "ITA Type E/F (CEE 7/7)", "ITA Type G (BS 1363)", "ITA Type H", "ITA Type I", "ITA Type J", "ITA Type K", "ITA Type L (CEI 23-50)", "ITA Type M (BS 546)", "ITA Type N", "ITA Type O", "USB Type A", "USB Type B", "USB Type C", "USB Mini A", "USB Mini B", "USB Micro A", "USB Micro B", "USB Micro AB", "USB 3.0 Type B", "USB 3.0 Micro B", "DC Terminal", "Saf-D-Grid", "Neutrik powerCON (20A)", "Neutrik powerCON (32A)", "Neutrik powerCON TRUE1", "Neutrik powerCON TRUE1 TOP", "Ubiquiti SmartPower", "Hardwired", "Other" ] }, "value": { "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] } } }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimPowerPortTemplates" }, "task": true }, { "name": "postDcimPowerPortTemplates", "summary": "dcim_power-port-templates_create", "description": "dcim_power-port-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimPowerPortTemplates" }, "task": true }, { "name": "putDcimPowerPortTemplates", "summary": "dcim_power-port-templates_bulk_update", "description": "dcim_power-port-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerPortTemplates" }, "task": true }, { "name": "patchDcimPowerPortTemplates", "summary": "dcim_power-port-templates_bulk_partial_update", "description": "dcim_power-port-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerPortTemplates" }, "task": true }, { "name": "deleteDcimPowerPortTemplates", "summary": "dcim_power-port-templates_bulk_delete", "description": "dcim_power-port-templates_bulk_delete", "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": "/deleteDcimPowerPortTemplates" }, "task": true }, { "name": "getDcimPowerPortTemplatesId", "summary": "dcim_power-port-templates_read", "description": "dcim_power-port-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerPortTemplatesId" }, "task": true }, { "name": "putDcimPowerPortTemplatesId", "summary": "dcim_power-port-templates_update", "description": "dcim_power-port-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerPortTemplatesId" }, "task": true }, { "name": "patchDcimPowerPortTemplatesId", "summary": "dcim_power-port-templates_partial_update", "description": "dcim_power-port-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerPortTemplatesId" }, "task": true }, { "name": "deleteDcimPowerPortTemplatesId", "summary": "dcim_power-port-templates_delete", "description": "dcim_power-port-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimPowerPortTemplatesId" }, "task": true }, { "name": "getDcimPowerPorts", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "maximumDraw", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDraw", "type": "string" } }, { "name": "allocatedDraw", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDraw", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "moduleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "connected", "type": "string", "info": ": string", "required": false, "schema": { "title": "connected", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "maximumDrawN", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawN", "type": "string" } }, { "name": "maximumDrawLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawLte", "type": "string" } }, { "name": "maximumDrawLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawLt", "type": "string" } }, { "name": "maximumDrawGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawGte", "type": "string" } }, { "name": "maximumDrawGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "maximumDrawGt", "type": "string" } }, { "name": "allocatedDrawN", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawN", "type": "string" } }, { "name": "allocatedDrawLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawLte", "type": "string" } }, { "name": "allocatedDrawLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawLt", "type": "string" } }, { "name": "allocatedDrawGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawGte", "type": "string" } }, { "name": "allocatedDrawGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "allocatedDrawGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "moduleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleIdN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module": { "required": [ "device" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "C6", "C8", "C14", "C16", "C20", "C22", "P+N+E 4H", "P+N+E 6H", "P+N+E 9H", "2P+E 4H", "2P+E 6H", "2P+E 9H", "3P+E 4H", "3P+E 6H", "3P+E 9H", "3P+N+E 4H", "3P+N+E 6H", "3P+N+E 9H", "NEMA 1-15P", "NEMA 5-15P", "NEMA 5-20P", "NEMA 5-30P", "NEMA 5-50P", "NEMA 6-15P", "NEMA 6-20P", "NEMA 6-30P", "NEMA 6-50P", "NEMA 10-30P", "NEMA 10-50P", "NEMA 14-20P", "NEMA 14-30P", "NEMA 14-50P", "NEMA 14-60P", "NEMA 15-15P", "NEMA 15-20P", "NEMA 15-30P", "NEMA 15-50P", "NEMA 15-60P", "NEMA L1-15P", "NEMA L5-15P", "NEMA L5-20P", "NEMA L5-30P", "NEMA L5-50P", "NEMA L6-15P", "NEMA L6-20P", "NEMA L6-30P", "NEMA L6-50P", "NEMA L10-30P", "NEMA L14-20P", "NEMA L14-30P", "NEMA L14-50P", "NEMA L14-60P", "NEMA L15-20P", "NEMA L15-30P", "NEMA L15-50P", "NEMA L15-60P", "NEMA L21-20P", "NEMA L21-30P", "NEMA L22-30P", "CS6361C", "CS6365C", "CS8165C", "CS8265C", "CS8365C", "CS8465C", "ITA Type C (CEE 7/16)", "ITA Type E (CEE 7/6)", "ITA Type F (CEE 7/4)", "ITA Type E/F (CEE 7/7)", "ITA Type G (BS 1363)", "ITA Type H", "ITA Type I", "ITA Type J", "ITA Type K", "ITA Type L (CEI 23-50)", "ITA Type M (BS 546)", "ITA Type N", "ITA Type O", "USB Type A", "USB Type B", "USB Type C", "USB Mini A", "USB Mini B", "USB Micro A", "USB Micro B", "USB Micro AB", "USB 3.0 Type B", "USB 3.0 Micro B", "DC Terminal", "Saf-D-Grid", "Neutrik powerCON (20A)", "Neutrik powerCON (32A)", "Neutrik powerCON TRUE1", "Neutrik powerCON TRUE1 TOP", "Ubiquiti SmartPower", "Hardwired", "Other" ] }, "value": { "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] } } }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimPowerPorts" }, "task": true }, { "name": "postDcimPowerPorts", "summary": "dcim_power-ports_create", "description": "dcim_power-ports_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimPowerPorts" }, "task": true }, { "name": "putDcimPowerPorts", "summary": "dcim_power-ports_bulk_update", "description": "dcim_power-ports_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerPorts" }, "task": true }, { "name": "patchDcimPowerPorts", "summary": "dcim_power-ports_bulk_partial_update", "description": "dcim_power-ports_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerPorts" }, "task": true }, { "name": "deleteDcimPowerPorts", "summary": "dcim_power-ports_bulk_delete", "description": "dcim_power-ports_bulk_delete", "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": "/deleteDcimPowerPorts" }, "task": true }, { "name": "getDcimPowerPortsId", "summary": "dcim_power-ports_read", "description": "dcim_power-ports_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerPortsId" }, "task": true }, { "name": "putDcimPowerPortsId", "summary": "dcim_power-ports_update", "description": "dcim_power-ports_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimPowerPortsId" }, "task": true }, { "name": "patchDcimPowerPortsId", "summary": "dcim_power-ports_partial_update", "description": "dcim_power-ports_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [iec-60320-c6, iec-60320-c8, iec-60320-c14, iec-60320-c16, iec-60320-c20, iec-60320-c22, iec-60309-p-n-e-4h, iec-60309-p-n-e-6h, iec-60309-p-n-e-9h, iec-60309-2p-e-4h, iec-60309-2p-e-6h, iec-60309-2p-e-9h, iec-60309-3p-e-4h, iec-60309-3p-e-6h, iec-60309-3p-e-9h, iec-60309-3p-n-e-4h, iec-60309-3p-n-e-6h, iec-60309-3p-n-e-9h, nema-1-15p, nema-5-15p, nema-5-20p, nema-5-30p, nema-5-50p, nema-6-15p, nema-6-20p, nema-6-30p, nema-6-50p, nema-10-30p, nema-10-50p, nema-14-20p, nema-14-30p, nema-14-50p, nema-14-60p, nema-15-15p, nema-15-20p, nema-15-30p, nema-15-50p, nema-15-60p, nema-l1-15p, nema-l5-15p, nema-l5-20p, nema-l5-30p, nema-l5-50p, nema-l6-15p, nema-l6-20p, nema-l6-30p, nema-l6-50p, nema-l10-30p, nema-l14-20p, nema-l14-30p, nema-l14-50p, nema-l14-60p, nema-l15-20p, nema-l15-30p, nema-l15-50p, nema-l15-60p, nema-l21-20p, nema-l21-30p, nema-l22-30p, cs6361c, cs6365c, cs8165c, cs8265c, cs8365c, cs8465c, ita-c, ita-e, ita-f, ita-ef, ita-g, ita-h, ita-i, ita-j, ita-k, ita-l, ita-m, ita-n, ita-o, usb-a, usb-b, usb-c, usb-mini-a, usb-mini-b, usb-micro-a, usb-micro-b, usb-micro-ab, usb-3-b, usb-3-micro-b, dc-terminal, saf-d-grid, neutrik-powercon-20, neutrik-powercon-32, neutrik-powercon-true1, neutrik-powercon-true1-top, ubiquiti-smartpower, hardwired, other]\", \"maximum_draw\": 123, \"allocated_draw\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"connected_endpoints\": \"array\", \"connected_endpoints_type\": \"string\", \"connected_endpoints_reachable\": \"boolean\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "description": "Physical port type", "type": "string", "enum": [ "iec-60320-c6", "iec-60320-c8", "iec-60320-c14", "iec-60320-c16", "iec-60320-c20", "iec-60320-c22", "iec-60309-p-n-e-4h", "iec-60309-p-n-e-6h", "iec-60309-p-n-e-9h", "iec-60309-2p-e-4h", "iec-60309-2p-e-6h", "iec-60309-2p-e-9h", "iec-60309-3p-e-4h", "iec-60309-3p-e-6h", "iec-60309-3p-e-9h", "iec-60309-3p-n-e-4h", "iec-60309-3p-n-e-6h", "iec-60309-3p-n-e-9h", "nema-1-15p", "nema-5-15p", "nema-5-20p", "nema-5-30p", "nema-5-50p", "nema-6-15p", "nema-6-20p", "nema-6-30p", "nema-6-50p", "nema-10-30p", "nema-10-50p", "nema-14-20p", "nema-14-30p", "nema-14-50p", "nema-14-60p", "nema-15-15p", "nema-15-20p", "nema-15-30p", "nema-15-50p", "nema-15-60p", "nema-l1-15p", "nema-l5-15p", "nema-l5-20p", "nema-l5-30p", "nema-l5-50p", "nema-l6-15p", "nema-l6-20p", "nema-l6-30p", "nema-l6-50p", "nema-l10-30p", "nema-l14-20p", "nema-l14-30p", "nema-l14-50p", "nema-l14-60p", "nema-l15-20p", "nema-l15-30p", "nema-l15-50p", "nema-l15-60p", "nema-l21-20p", "nema-l21-30p", "nema-l22-30p", "cs6361c", "cs6365c", "cs8165c", "cs8265c", "cs8365c", "cs8465c", "ita-c", "ita-e", "ita-f", "ita-ef", "ita-g", "ita-h", "ita-i", "ita-j", "ita-k", "ita-l", "ita-m", "ita-n", "ita-o", "usb-a", "usb-b", "usb-c", "usb-mini-a", "usb-mini-b", "usb-micro-a", "usb-micro-b", "usb-micro-ab", "usb-3-b", "usb-3-micro-b", "dc-terminal", "saf-d-grid", "neutrik-powercon-20", "neutrik-powercon-32", "neutrik-powercon-true1", "neutrik-powercon-true1-top", "ubiquiti-smartpower", "hardwired", "other" ] }, "maximum_draw": { "title": "Maximum draw", "description": "Maximum power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "allocated_draw": { "title": "Allocated draw", "description": "Allocated power draw (watts)", "type": "integer", "maximum": 32767, "minimum": 1, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "connected_endpoints": { "description": "\nReturn the appropriate serializer for the type of connected object.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "connected_endpoints_type": { "title": "Connected endpoints type", "type": "string", "readOnly": true }, "connected_endpoints_reachable": { "title": "Connected endpoints reachable", "type": "boolean", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimPowerPortsId" }, "task": true }, { "name": "deleteDcimPowerPortsId", "summary": "dcim_power-ports_delete", "description": "dcim_power-ports_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimPowerPortsId" }, "task": true }, { "name": "getDcimPowerPortsIdTrace", "summary": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin", "description": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this power port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimPowerPortsIdTrace" }, "task": true }, { "name": "getDcimRackReservations", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "userId", "type": "string", "info": ": string", "required": false, "schema": { "title": "userId", "type": "string" } }, { "name": "user", "type": "string", "info": ": string", "required": false, "schema": { "title": "user", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "userIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userIdN", "type": "string" } }, { "name": "userN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "rack", "units", "user", "description" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "rack": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "units": { "type": "array", "items": { "title": "Units", "type": "integer", "maximum": 32767, "minimum": 0 } }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "user": { "required": [ "username" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimRackReservations" }, "task": true }, { "name": "postDcimRackReservations", "summary": "dcim_rack-reservations_create", "description": "dcim_rack-reservations_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"rack\": 123, \"units\": \"array\", \"created\": \"string\", \"last_updated\": \"string\", \"user\": 123, \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\"}", "required": true, "schema": { "required": [ "rack", "units", "user", "description" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "rack": { "title": "Rack", "type": "integer" }, "units": { "type": "array", "items": { "title": "Units", "type": "integer", "maximum": 32767, "minimum": 0 } }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "user": { "title": "User", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimRackReservations" }, "task": true }, { "name": "putDcimRackReservations", "summary": "dcim_rack-reservations_bulk_update", "description": "dcim_rack-reservations_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"rack\": 123, \"units\": \"array\", \"created\": \"string\", \"last_updated\": \"string\", \"user\": 123, \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\"}", "required": true, "schema": { "required": [ "rack", "units", "user", "description" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "rack": { "title": "Rack", "type": "integer" }, "units": { "type": "array", "items": { "title": "Units", "type": "integer", "maximum": 32767, "minimum": 0 } }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "user": { "title": "User", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRackReservations" }, "task": true }, { "name": "patchDcimRackReservations", "summary": "dcim_rack-reservations_bulk_partial_update", "description": "dcim_rack-reservations_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"rack\": 123, \"units\": \"array\", \"created\": \"string\", \"last_updated\": \"string\", \"user\": 123, \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\"}", "required": true, "schema": { "required": [ "rack", "units", "user", "description" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "rack": { "title": "Rack", "type": "integer" }, "units": { "type": "array", "items": { "title": "Units", "type": "integer", "maximum": 32767, "minimum": 0 } }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "user": { "title": "User", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRackReservations" }, "task": true }, { "name": "deleteDcimRackReservations", "summary": "dcim_rack-reservations_bulk_delete", "description": "dcim_rack-reservations_bulk_delete", "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": "/deleteDcimRackReservations" }, "task": true }, { "name": "getDcimRackReservationsId", "summary": "dcim_rack-reservations_read", "description": "dcim_rack-reservations_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack reservation.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimRackReservationsId" }, "task": true }, { "name": "putDcimRackReservationsId", "summary": "dcim_rack-reservations_update", "description": "dcim_rack-reservations_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack reservation.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"rack\": 123, \"units\": \"array\", \"created\": \"string\", \"last_updated\": \"string\", \"user\": 123, \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\"}", "required": true, "schema": { "required": [ "rack", "units", "user", "description" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "rack": { "title": "Rack", "type": "integer" }, "units": { "type": "array", "items": { "title": "Units", "type": "integer", "maximum": 32767, "minimum": 0 } }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "user": { "title": "User", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRackReservationsId" }, "task": true }, { "name": "patchDcimRackReservationsId", "summary": "dcim_rack-reservations_partial_update", "description": "dcim_rack-reservations_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack reservation.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"rack\": 123, \"units\": \"array\", \"created\": \"string\", \"last_updated\": \"string\", \"user\": 123, \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\"}", "required": true, "schema": { "required": [ "rack", "units", "user", "description" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "rack": { "title": "Rack", "type": "integer" }, "units": { "type": "array", "items": { "title": "Units", "type": "integer", "maximum": 32767, "minimum": 0 } }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "user": { "title": "User", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200, "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRackReservationsId" }, "task": true }, { "name": "deleteDcimRackReservationsId", "summary": "dcim_rack-reservations_delete", "description": "dcim_rack-reservations_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack reservation.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimRackReservationsId" }, "task": true }, { "name": "getDcimRackRoles", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "colorIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIc", "type": "string" } }, { "name": "colorNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNic", "type": "string" } }, { "name": "colorIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIew", "type": "string" } }, { "name": "colorNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNiew", "type": "string" } }, { "name": "colorIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIsw", "type": "string" } }, { "name": "colorNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNisw", "type": "string" } }, { "name": "colorIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIe", "type": "string" } }, { "name": "colorNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimRackRoles" }, "task": true }, { "name": "postDcimRackRoles", "summary": "dcim_rack-roles_create", "description": "dcim_rack-roles_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimRackRoles" }, "task": true }, { "name": "putDcimRackRoles", "summary": "dcim_rack-roles_bulk_update", "description": "dcim_rack-roles_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRackRoles" }, "task": true }, { "name": "patchDcimRackRoles", "summary": "dcim_rack-roles_bulk_partial_update", "description": "dcim_rack-roles_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRackRoles" }, "task": true }, { "name": "deleteDcimRackRoles", "summary": "dcim_rack-roles_bulk_delete", "description": "dcim_rack-roles_bulk_delete", "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": "/deleteDcimRackRoles" }, "task": true }, { "name": "getDcimRackRolesId", "summary": "dcim_rack-roles_read", "description": "dcim_rack-roles_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack role.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimRackRolesId" }, "task": true }, { "name": "putDcimRackRolesId", "summary": "dcim_rack-roles_update", "description": "dcim_rack-roles_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRackRolesId" }, "task": true }, { "name": "patchDcimRackRolesId", "summary": "dcim_rack-roles_partial_update", "description": "dcim_rack-roles_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"rack_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRackRolesId" }, "task": true }, { "name": "deleteDcimRackRolesId", "summary": "dcim_rack-roles_delete", "description": "dcim_rack-roles_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack role.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimRackRolesId" }, "task": true }, { "name": "getDcimRacks", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "facilityId", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityId", "type": "string" } }, { "name": "assetTag", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTag", "type": "string" } }, { "name": "uHeight", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeight", "type": "string" } }, { "name": "descUnits", "type": "string", "info": ": string", "required": false, "schema": { "title": "descUnits", "type": "string" } }, { "name": "outerWidth", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerWidth", "type": "string" } }, { "name": "outerDepth", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerDepth", "type": "string" } }, { "name": "outerUnit", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerUnit", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "width", "type": "string", "info": ": string", "required": false, "schema": { "title": "width", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "serial", "type": "string", "info": ": string", "required": false, "schema": { "title": "serial", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "facilityIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdN", "type": "string" } }, { "name": "facilityIdIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdIc", "type": "string" } }, { "name": "facilityIdNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdNic", "type": "string" } }, { "name": "facilityIdIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdIew", "type": "string" } }, { "name": "facilityIdNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdNiew", "type": "string" } }, { "name": "facilityIdIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdIsw", "type": "string" } }, { "name": "facilityIdNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdNisw", "type": "string" } }, { "name": "facilityIdIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdIe", "type": "string" } }, { "name": "facilityIdNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIdNie", "type": "string" } }, { "name": "assetTagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagN", "type": "string" } }, { "name": "assetTagIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIc", "type": "string" } }, { "name": "assetTagNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNic", "type": "string" } }, { "name": "assetTagIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIew", "type": "string" } }, { "name": "assetTagNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNiew", "type": "string" } }, { "name": "assetTagIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIsw", "type": "string" } }, { "name": "assetTagNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNisw", "type": "string" } }, { "name": "assetTagIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagIe", "type": "string" } }, { "name": "assetTagNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "assetTagNie", "type": "string" } }, { "name": "uHeightN", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightN", "type": "string" } }, { "name": "uHeightLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightLte", "type": "string" } }, { "name": "uHeightLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightLt", "type": "string" } }, { "name": "uHeightGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightGte", "type": "string" } }, { "name": "uHeightGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "uHeightGt", "type": "string" } }, { "name": "outerWidthN", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerWidthN", "type": "string" } }, { "name": "outerWidthLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerWidthLte", "type": "string" } }, { "name": "outerWidthLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerWidthLt", "type": "string" } }, { "name": "outerWidthGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerWidthGte", "type": "string" } }, { "name": "outerWidthGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerWidthGt", "type": "string" } }, { "name": "outerDepthN", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerDepthN", "type": "string" } }, { "name": "outerDepthLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerDepthLte", "type": "string" } }, { "name": "outerDepthLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerDepthLt", "type": "string" } }, { "name": "outerDepthGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerDepthGte", "type": "string" } }, { "name": "outerDepthGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerDepthGt", "type": "string" } }, { "name": "outerUnitN", "type": "string", "info": ": string", "required": false, "schema": { "title": "outerUnitN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "widthN", "type": "string", "info": ": string", "required": false, "schema": { "title": "widthN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "serialN", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialN", "type": "string" } }, { "name": "serialIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIc", "type": "string" } }, { "name": "serialNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNic", "type": "string" } }, { "name": "serialIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIew", "type": "string" } }, { "name": "serialNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNiew", "type": "string" } }, { "name": "serialIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIsw", "type": "string" } }, { "name": "serialNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNisw", "type": "string" } }, { "name": "serialIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialIe", "type": "string" } }, { "name": "serialNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "serialNie", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "facility_id": { "title": "Facility ID", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "location": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Reserved", "Available", "Planned", "Active", "Deprecated" ] }, "value": { "type": "string", "enum": [ "reserved", "available", "planned", "active", "deprecated" ] } } }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this rack", "type": "string", "maxLength": 50, "x-nullable": true }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "2-post frame", "4-post frame", "4-post cabinet", "Wall-mounted frame", "Wall-mounted cabinet" ] }, "value": { "type": "string", "enum": [ "2-post-frame", "4-post-frame", "4-post-cabinet", "wall-frame", "wall-cabinet" ] } } }, "width": { "title": "Width", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "10 inches", "19 inches", "21 inches", "23 inches" ] }, "value": { "type": "integer", "enum": [ 10, 19, 21, 23 ] } } }, "u_height": { "title": "Height (U)", "description": "Height in rack units", "type": "integer", "maximum": 100, "minimum": 1 }, "desc_units": { "title": "Descending units", "description": "Units are numbered top-to-bottom", "type": "boolean" }, "outer_width": { "title": "Outer width", "description": "Outer dimension of rack (width)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_depth": { "title": "Outer depth", "description": "Outer dimension of rack (depth)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_unit": { "title": "Outer unit", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Millimeters", "Inches" ] }, "value": { "type": "string", "enum": [ "mm", "in" ] } } }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimRacks" }, "task": true }, { "name": "postDcimRacks", "summary": "dcim_racks_create", "description": "dcim_racks_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"facility_id\": \"string\", \"site\": 123, \"location\": 123, \"tenant\": 123, \"status\": \"Must be one of [reserved, available, planned, active, deprecated]\", \"role\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"type\": \"Must be one of [2-post-frame, 4-post-frame, 4-post-cabinet, wall-frame, wall-cabinet]\", \"width\": 123, \"u_height\": 123, \"desc_units\": \"boolean\", \"outer_width\": 123, \"outer_depth\": 123, \"outer_unit\": \"Must be one of [mm, in]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"powerfeed_count\": 123}", "required": true, "schema": { "required": [ "name", "site", "location" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "facility_id": { "title": "Facility ID", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "reserved", "available", "planned", "active", "deprecated" ] }, "role": { "title": "Role", "description": "Functional role", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this rack", "type": "string", "maxLength": 50, "x-nullable": true }, "type": { "title": "Type", "type": "string", "enum": [ "2-post-frame", "4-post-frame", "4-post-cabinet", "wall-frame", "wall-cabinet" ] }, "width": { "title": "Width", "description": "Rail-to-rail width", "type": "integer", "enum": [ 10, 19, 21, 23 ] }, "u_height": { "title": "Height (U)", "description": "Height in rack units", "type": "integer", "maximum": 100, "minimum": 1 }, "desc_units": { "title": "Descending units", "description": "Units are numbered top-to-bottom", "type": "boolean" }, "outer_width": { "title": "Outer width", "description": "Outer dimension of rack (width)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_depth": { "title": "Outer depth", "description": "Outer dimension of rack (depth)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_unit": { "title": "Outer unit", "type": "string", "enum": [ "mm", "in" ] }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimRacks" }, "task": true }, { "name": "putDcimRacks", "summary": "dcim_racks_bulk_update", "description": "dcim_racks_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"facility_id\": \"string\", \"site\": 123, \"location\": 123, \"tenant\": 123, \"status\": \"Must be one of [reserved, available, planned, active, deprecated]\", \"role\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"type\": \"Must be one of [2-post-frame, 4-post-frame, 4-post-cabinet, wall-frame, wall-cabinet]\", \"width\": 123, \"u_height\": 123, \"desc_units\": \"boolean\", \"outer_width\": 123, \"outer_depth\": 123, \"outer_unit\": \"Must be one of [mm, in]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"powerfeed_count\": 123}", "required": true, "schema": { "required": [ "name", "site", "location" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "facility_id": { "title": "Facility ID", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "reserved", "available", "planned", "active", "deprecated" ] }, "role": { "title": "Role", "description": "Functional role", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this rack", "type": "string", "maxLength": 50, "x-nullable": true }, "type": { "title": "Type", "type": "string", "enum": [ "2-post-frame", "4-post-frame", "4-post-cabinet", "wall-frame", "wall-cabinet" ] }, "width": { "title": "Width", "description": "Rail-to-rail width", "type": "integer", "enum": [ 10, 19, 21, 23 ] }, "u_height": { "title": "Height (U)", "description": "Height in rack units", "type": "integer", "maximum": 100, "minimum": 1 }, "desc_units": { "title": "Descending units", "description": "Units are numbered top-to-bottom", "type": "boolean" }, "outer_width": { "title": "Outer width", "description": "Outer dimension of rack (width)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_depth": { "title": "Outer depth", "description": "Outer dimension of rack (depth)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_unit": { "title": "Outer unit", "type": "string", "enum": [ "mm", "in" ] }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRacks" }, "task": true }, { "name": "patchDcimRacks", "summary": "dcim_racks_bulk_partial_update", "description": "dcim_racks_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"facility_id\": \"string\", \"site\": 123, \"location\": 123, \"tenant\": 123, \"status\": \"Must be one of [reserved, available, planned, active, deprecated]\", \"role\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"type\": \"Must be one of [2-post-frame, 4-post-frame, 4-post-cabinet, wall-frame, wall-cabinet]\", \"width\": 123, \"u_height\": 123, \"desc_units\": \"boolean\", \"outer_width\": 123, \"outer_depth\": 123, \"outer_unit\": \"Must be one of [mm, in]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"powerfeed_count\": 123}", "required": true, "schema": { "required": [ "name", "site", "location" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "facility_id": { "title": "Facility ID", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "reserved", "available", "planned", "active", "deprecated" ] }, "role": { "title": "Role", "description": "Functional role", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this rack", "type": "string", "maxLength": 50, "x-nullable": true }, "type": { "title": "Type", "type": "string", "enum": [ "2-post-frame", "4-post-frame", "4-post-cabinet", "wall-frame", "wall-cabinet" ] }, "width": { "title": "Width", "description": "Rail-to-rail width", "type": "integer", "enum": [ 10, 19, 21, 23 ] }, "u_height": { "title": "Height (U)", "description": "Height in rack units", "type": "integer", "maximum": 100, "minimum": 1 }, "desc_units": { "title": "Descending units", "description": "Units are numbered top-to-bottom", "type": "boolean" }, "outer_width": { "title": "Outer width", "description": "Outer dimension of rack (width)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_depth": { "title": "Outer depth", "description": "Outer dimension of rack (depth)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_unit": { "title": "Outer unit", "type": "string", "enum": [ "mm", "in" ] }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRacks" }, "task": true }, { "name": "deleteDcimRacks", "summary": "dcim_racks_bulk_delete", "description": "dcim_racks_bulk_delete", "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": "/deleteDcimRacks" }, "task": true }, { "name": "getDcimRacksId", "summary": "dcim_racks_read", "description": "dcim_racks_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimRacksId" }, "task": true }, { "name": "putDcimRacksId", "summary": "dcim_racks_update", "description": "dcim_racks_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"facility_id\": \"string\", \"site\": 123, \"location\": 123, \"tenant\": 123, \"status\": \"Must be one of [reserved, available, planned, active, deprecated]\", \"role\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"type\": \"Must be one of [2-post-frame, 4-post-frame, 4-post-cabinet, wall-frame, wall-cabinet]\", \"width\": 123, \"u_height\": 123, \"desc_units\": \"boolean\", \"outer_width\": 123, \"outer_depth\": 123, \"outer_unit\": \"Must be one of [mm, in]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"powerfeed_count\": 123}", "required": true, "schema": { "required": [ "name", "site", "location" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "facility_id": { "title": "Facility ID", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "reserved", "available", "planned", "active", "deprecated" ] }, "role": { "title": "Role", "description": "Functional role", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this rack", "type": "string", "maxLength": 50, "x-nullable": true }, "type": { "title": "Type", "type": "string", "enum": [ "2-post-frame", "4-post-frame", "4-post-cabinet", "wall-frame", "wall-cabinet" ] }, "width": { "title": "Width", "description": "Rail-to-rail width", "type": "integer", "enum": [ 10, 19, 21, 23 ] }, "u_height": { "title": "Height (U)", "description": "Height in rack units", "type": "integer", "maximum": 100, "minimum": 1 }, "desc_units": { "title": "Descending units", "description": "Units are numbered top-to-bottom", "type": "boolean" }, "outer_width": { "title": "Outer width", "description": "Outer dimension of rack (width)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_depth": { "title": "Outer depth", "description": "Outer dimension of rack (depth)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_unit": { "title": "Outer unit", "type": "string", "enum": [ "mm", "in" ] }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRacksId" }, "task": true }, { "name": "patchDcimRacksId", "summary": "dcim_racks_partial_update", "description": "dcim_racks_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"facility_id\": \"string\", \"site\": 123, \"location\": 123, \"tenant\": 123, \"status\": \"Must be one of [reserved, available, planned, active, deprecated]\", \"role\": 123, \"serial\": \"string\", \"asset_tag\": \"string\", \"type\": \"Must be one of [2-post-frame, 4-post-frame, 4-post-cabinet, wall-frame, wall-cabinet]\", \"width\": 123, \"u_height\": 123, \"desc_units\": \"boolean\", \"outer_width\": 123, \"outer_depth\": 123, \"outer_unit\": \"Must be one of [mm, in]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"powerfeed_count\": 123}", "required": true, "schema": { "required": [ "name", "site", "location" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "facility_id": { "title": "Facility ID", "type": "string", "maxLength": 50, "x-nullable": true }, "site": { "title": "Site", "type": "integer" }, "location": { "title": "Location", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "reserved", "available", "planned", "active", "deprecated" ] }, "role": { "title": "Role", "description": "Functional role", "type": "integer", "x-nullable": true }, "serial": { "title": "Serial number", "type": "string", "maxLength": 50 }, "asset_tag": { "title": "Asset tag", "description": "A unique tag used to identify this rack", "type": "string", "maxLength": 50, "x-nullable": true }, "type": { "title": "Type", "type": "string", "enum": [ "2-post-frame", "4-post-frame", "4-post-cabinet", "wall-frame", "wall-cabinet" ] }, "width": { "title": "Width", "description": "Rail-to-rail width", "type": "integer", "enum": [ 10, 19, 21, 23 ] }, "u_height": { "title": "Height (U)", "description": "Height in rack units", "type": "integer", "maximum": 100, "minimum": 1 }, "desc_units": { "title": "Descending units", "description": "Units are numbered top-to-bottom", "type": "boolean" }, "outer_width": { "title": "Outer width", "description": "Outer dimension of rack (width)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_depth": { "title": "Outer depth", "description": "Outer dimension of rack (depth)", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "outer_unit": { "title": "Outer unit", "type": "string", "enum": [ "mm", "in" ] }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "powerfeed_count": { "title": "Powerfeed count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRacksId" }, "task": true }, { "name": "deleteDcimRacksId", "summary": "dcim_racks_delete", "description": "dcim_racks_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimRacksId" }, "task": true }, { "name": "getDcimRacksIdElevation", "summary": "Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.", "description": "Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rack.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "face", "type": "string", "info": ": Must be one of [front, rear]", "required": false, "schema": { "title": "face", "type": "string" } }, { "name": "render", "type": "string", "info": ": Must be one of [json, svg]", "required": false, "schema": { "title": "render", "type": "string" } }, { "name": "unitWidth", "type": "number", "info": ": 123", "required": false, "schema": { "title": "unitWidth", "type": "number" } }, { "name": "unitHeight", "type": "number", "info": ": 123", "required": false, "schema": { "title": "unitHeight", "type": "number" } }, { "name": "legendWidth", "type": "number", "info": ": 123", "required": false, "schema": { "title": "legendWidth", "type": "number" } }, { "name": "marginWidth", "type": "number", "info": ": 123", "required": false, "schema": { "title": "marginWidth", "type": "number" } }, { "name": "exclude", "type": "number", "info": ": 123", "required": false, "schema": { "title": "exclude", "type": "number" } }, { "name": "expandDevices", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "expandDevices", "type": "boolean" } }, { "name": "includeImages", "type": "boolean", "info": ": boolean", "required": false, "schema": { "title": "includeImages", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "title": "Id", "type": "number", "readOnly": true }, "name": { "title": "Name", "type": "string", "readOnly": true, "minLength": 1 }, "face": { "title": "Face", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Front", "Rear" ] }, "value": { "type": "string", "enum": [ "front", "rear" ] } }, "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "occupied": { "title": "Occupied", "type": "boolean", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimRacksIdElevation" }, "task": true }, { "name": "getDcimRearPortTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "positions", "type": "string", "info": ": string", "required": false, "schema": { "title": "positions", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "devicetypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeId", "type": "string" } }, { "name": "moduletypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "colorIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIc", "type": "string" } }, { "name": "colorNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNic", "type": "string" } }, { "name": "colorIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIew", "type": "string" } }, { "name": "colorNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNiew", "type": "string" } }, { "name": "colorIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIsw", "type": "string" } }, { "name": "colorNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNisw", "type": "string" } }, { "name": "colorIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIe", "type": "string" } }, { "name": "colorNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNie", "type": "string" } }, { "name": "positionsN", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsN", "type": "string" } }, { "name": "positionsLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsLte", "type": "string" } }, { "name": "positionsLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsLt", "type": "string" } }, { "name": "positionsGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsGte", "type": "string" } }, { "name": "positionsGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsGt", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "devicetypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "devicetypeIdN", "type": "string" } }, { "name": "moduletypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduletypeIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "module_type": { "required": [ "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "8P8C", "8P6C", "8P4C", "8P2C", "6P6C", "6P4C", "6P2C", "4P4C", "4P2C", "GG45", "TERA 4P", "TERA 2P", "TERA 1P", "110 Punch", "BNC", "F Connector", "N Connector", "MRJ21", "FC", "LC", "LC/PC", "LC/UPC", "LC/APC", "LSH", "LSH/PC", "LSH/UPC", "LSH/APC", "MPO", "MTRJ", "SC", "SC/PC", "SC/UPC", "SC/APC", "ST", "CS", "SN", "SMA 905", "SMA 906", "URM-P2", "URM-P4", "URM-P8", "Splice", "Other" ] }, "value": { "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] } } }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimRearPortTemplates" }, "task": true }, { "name": "postDcimRearPortTemplates", "summary": "dcim_rear-port-templates_create", "description": "dcim_rear-port-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimRearPortTemplates" }, "task": true }, { "name": "putDcimRearPortTemplates", "summary": "dcim_rear-port-templates_bulk_update", "description": "dcim_rear-port-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRearPortTemplates" }, "task": true }, { "name": "patchDcimRearPortTemplates", "summary": "dcim_rear-port-templates_bulk_partial_update", "description": "dcim_rear-port-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRearPortTemplates" }, "task": true }, { "name": "deleteDcimRearPortTemplates", "summary": "dcim_rear-port-templates_bulk_delete", "description": "dcim_rear-port-templates_bulk_delete", "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": "/deleteDcimRearPortTemplates" }, "task": true }, { "name": "getDcimRearPortTemplatesId", "summary": "dcim_rear-port-templates_read", "description": "dcim_rear-port-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port template.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimRearPortTemplatesId" }, "task": true }, { "name": "putDcimRearPortTemplatesId", "summary": "dcim_rear-port-templates_update", "description": "dcim_rear-port-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRearPortTemplatesId" }, "task": true }, { "name": "patchDcimRearPortTemplatesId", "summary": "dcim_rear-port-templates_partial_update", "description": "dcim_rear-port-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device_type\": 123, \"module_type\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "device_type", "module_type", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device_type": { "title": "Device type", "type": "integer", "x-nullable": true }, "module_type": { "title": "Module type", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "description": "\n{module} is accepted as a substitution for the module bay position when attached to a module type.\n", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRearPortTemplatesId" }, "task": true }, { "name": "deleteDcimRearPortTemplatesId", "summary": "dcim_rear-port-templates_delete", "description": "dcim_rear-port-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimRearPortTemplatesId" }, "task": true }, { "name": "getDcimRearPorts", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "label", "type": "string", "info": ": string", "required": false, "schema": { "title": "label", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "positions", "type": "string", "info": ": string", "required": false, "schema": { "title": "positions", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "cableEnd", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEnd", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "rackId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackId", "type": "string" } }, { "name": "rack", "type": "string", "info": ": string", "required": false, "schema": { "title": "rack", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualChassisId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisId", "type": "string" } }, { "name": "virtualChassis", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassis", "type": "string" } }, { "name": "moduleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "cabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "cabled", "type": "string" } }, { "name": "occupied", "type": "string", "info": ": string", "required": false, "schema": { "title": "occupied", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "labelN", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelN", "type": "string" } }, { "name": "labelIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIc", "type": "string" } }, { "name": "labelNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNic", "type": "string" } }, { "name": "labelIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIew", "type": "string" } }, { "name": "labelNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNiew", "type": "string" } }, { "name": "labelIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIsw", "type": "string" } }, { "name": "labelNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNisw", "type": "string" } }, { "name": "labelIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelIe", "type": "string" } }, { "name": "labelNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "labelNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "colorIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIc", "type": "string" } }, { "name": "colorNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNic", "type": "string" } }, { "name": "colorIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIew", "type": "string" } }, { "name": "colorNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNiew", "type": "string" } }, { "name": "colorIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIsw", "type": "string" } }, { "name": "colorNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNisw", "type": "string" } }, { "name": "colorIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIe", "type": "string" } }, { "name": "colorNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNie", "type": "string" } }, { "name": "positionsN", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsN", "type": "string" } }, { "name": "positionsLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsLte", "type": "string" } }, { "name": "positionsLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsLt", "type": "string" } }, { "name": "positionsGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsGte", "type": "string" } }, { "name": "positionsGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "positionsGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "cableEndN", "type": "string", "info": ": string", "required": false, "schema": { "title": "cableEndN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "rackIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackIdN", "type": "string" } }, { "name": "rackN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rackN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualChassisIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisIdN", "type": "string" } }, { "name": "virtualChassisN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualChassisN", "type": "string" } }, { "name": "moduleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "moduleIdN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "module": { "required": [ "device" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module_bay": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } } } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "8P8C", "8P6C", "8P4C", "8P2C", "6P6C", "6P4C", "6P2C", "4P4C", "4P2C", "GG45", "TERA 4P", "TERA 2P", "TERA 1P", "110 Punch", "BNC", "F Connector", "N Connector", "MRJ21", "FC", "LC", "LC/PC", "LC/UPC", "LC/APC", "LSH", "LSH/PC", "LSH/UPC", "LSH/APC", "MPO", "MTRJ", "SC", "SC/PC", "SC/UPC", "SC/APC", "ST", "CS", "SN", "SMA 905", "SMA 906", "URM-P2", "URM-P4", "URM-P8", "Splice", "Other" ] }, "value": { "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] } } }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimRearPorts" }, "task": true }, { "name": "postDcimRearPorts", "summary": "dcim_rear-ports_create", "description": "dcim_rear-ports_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimRearPorts" }, "task": true }, { "name": "putDcimRearPorts", "summary": "dcim_rear-ports_bulk_update", "description": "dcim_rear-ports_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRearPorts" }, "task": true }, { "name": "patchDcimRearPorts", "summary": "dcim_rear-ports_bulk_partial_update", "description": "dcim_rear-ports_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRearPorts" }, "task": true }, { "name": "deleteDcimRearPorts", "summary": "dcim_rear-ports_bulk_delete", "description": "dcim_rear-ports_bulk_delete", "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": "/deleteDcimRearPorts" }, "task": true }, { "name": "getDcimRearPortsId", "summary": "dcim_rear-ports_read", "description": "dcim_rear-ports_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimRearPortsId" }, "task": true }, { "name": "putDcimRearPortsId", "summary": "dcim_rear-ports_update", "description": "dcim_rear-ports_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRearPortsId" }, "task": true }, { "name": "patchDcimRearPortsId", "summary": "dcim_rear-ports_partial_update", "description": "dcim_rear-ports_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"module\": 123, \"name\": \"string\", \"label\": \"string\", \"type\": \"Must be one of [8p8c, 8p6c, 8p4c, 8p2c, 6p6c, 6p4c, 6p2c, 4p4c, 4p2c, gg45, tera-4p, tera-2p, tera-1p, 110-punch, bnc, f, n, mrj21, fc, lc, lc-pc, lc-upc, lc-apc, lsh, lsh-pc, lsh-upc, lsh-apc, mpo, mtrj, sc, sc-pc, sc-upc, sc-apc, st, cs, sn, sma-905, sma-906, urm-p2, urm-p4, urm-p8, splice, other]\", \"color\": \"string\", \"positions\": 123, \"description\": \"string\", \"mark_connected\": \"boolean\", \"cable\": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"label\": \"string\"}, \"cable_end\": \"string\", \"link_peers\": \"array\", \"link_peers_type\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"_occupied\": \"boolean\"}", "required": true, "schema": { "required": [ "device", "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer" }, "module": { "title": "Module", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "label": { "title": "Label", "description": "Physical label", "type": "string", "maxLength": 64 }, "type": { "title": "Type", "type": "string", "enum": [ "8p8c", "8p6c", "8p4c", "8p2c", "6p6c", "6p4c", "6p2c", "4p4c", "4p2c", "gg45", "tera-4p", "tera-2p", "tera-1p", "110-punch", "bnc", "f", "n", "mrj21", "fc", "lc", "lc-pc", "lc-upc", "lc-apc", "lsh", "lsh-pc", "lsh-upc", "lsh-apc", "mpo", "mtrj", "sc", "sc-pc", "sc-upc", "sc-apc", "st", "cs", "sn", "sma-905", "sma-906", "urm-p2", "urm-p4", "urm-p8", "splice", "other" ] }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6 }, "positions": { "title": "Positions", "type": "integer", "maximum": 1024, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mark_connected": { "title": "Mark connected", "description": "Treat as if a cable is connected", "type": "boolean" }, "cable": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "label": { "title": "Label", "type": "string", "maxLength": 100 } } }, "cable_end": { "title": "Cable end", "type": "string", "readOnly": true, "minLength": 1 }, "link_peers": { "description": "\nReturn the appropriate serializer for the link termination model.\n", "type": "array", "items": { "type": "string", "x-nullable": true }, "readOnly": true }, "link_peers_type": { "title": "Link peers type", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRearPortsId" }, "task": true }, { "name": "deleteDcimRearPortsId", "summary": "dcim_rear-ports_delete", "description": "dcim_rear-ports_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimRearPortsId" }, "task": true }, { "name": "getDcimRearPortsIdPaths", "summary": "Return all CablePaths which traverse a given pass-through port.", "description": "Return all CablePaths which traverse a given pass-through port.", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this rear port.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimRearPortsIdPaths" }, "task": true }, { "name": "getDcimRegions", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "parent", "type": "string", "info": ": string", "required": false, "schema": { "title": "parent", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "parentN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimRegions" }, "task": true }, { "name": "postDcimRegions", "summary": "dcim_regions_create", "description": "dcim_regions_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimRegions" }, "task": true }, { "name": "putDcimRegions", "summary": "dcim_regions_bulk_update", "description": "dcim_regions_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRegions" }, "task": true }, { "name": "patchDcimRegions", "summary": "dcim_regions_bulk_partial_update", "description": "dcim_regions_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRegions" }, "task": true }, { "name": "deleteDcimRegions", "summary": "dcim_regions_bulk_delete", "description": "dcim_regions_bulk_delete", "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": "/deleteDcimRegions" }, "task": true }, { "name": "getDcimRegionsId", "summary": "dcim_regions_read", "description": "dcim_regions_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this region.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimRegionsId" }, "task": true }, { "name": "putDcimRegionsId", "summary": "dcim_regions_update", "description": "dcim_regions_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this region.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimRegionsId" }, "task": true }, { "name": "patchDcimRegionsId", "summary": "dcim_regions_partial_update", "description": "dcim_regions_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this region.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimRegionsId" }, "task": true }, { "name": "deleteDcimRegionsId", "summary": "dcim_regions_delete", "description": "dcim_regions_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this region.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimRegionsId" }, "task": true }, { "name": "getDcimSiteGroups", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "parent", "type": "string", "info": ": string", "required": false, "schema": { "title": "parent", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "parentN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimSiteGroups" }, "task": true }, { "name": "postDcimSiteGroups", "summary": "dcim_site-groups_create", "description": "dcim_site-groups_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimSiteGroups" }, "task": true }, { "name": "putDcimSiteGroups", "summary": "dcim_site-groups_bulk_update", "description": "dcim_site-groups_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimSiteGroups" }, "task": true }, { "name": "patchDcimSiteGroups", "summary": "dcim_site-groups_bulk_partial_update", "description": "dcim_site-groups_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimSiteGroups" }, "task": true }, { "name": "deleteDcimSiteGroups", "summary": "dcim_site-groups_bulk_delete", "description": "dcim_site-groups_bulk_delete", "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": "/deleteDcimSiteGroups" }, "task": true }, { "name": "getDcimSiteGroupsId", "summary": "dcim_site-groups_read", "description": "dcim_site-groups_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this site group.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimSiteGroupsId" }, "task": true }, { "name": "putDcimSiteGroupsId", "summary": "dcim_site-groups_update", "description": "dcim_site-groups_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this site group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimSiteGroupsId" }, "task": true }, { "name": "patchDcimSiteGroupsId", "summary": "dcim_site-groups_partial_update", "description": "dcim_site-groups_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this site group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"site_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimSiteGroupsId" }, "task": true }, { "name": "deleteDcimSiteGroupsId", "summary": "dcim_site-groups_delete", "description": "dcim_site-groups_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this site group.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimSiteGroupsId" }, "task": true }, { "name": "getDcimSites", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "facility", "type": "string", "info": ": string", "required": false, "schema": { "title": "facility", "type": "string" } }, { "name": "latitude", "type": "string", "info": ": string", "required": false, "schema": { "title": "latitude", "type": "string" } }, { "name": "longitude", "type": "string", "info": ": string", "required": false, "schema": { "title": "longitude", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "group", "type": "string", "info": ": string", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "asn", "type": "string", "info": ": string", "required": false, "schema": { "title": "asn", "type": "string" } }, { "name": "asnId", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "facilityN", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityN", "type": "string" } }, { "name": "facilityIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIc", "type": "string" } }, { "name": "facilityNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityNic", "type": "string" } }, { "name": "facilityIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIew", "type": "string" } }, { "name": "facilityNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityNiew", "type": "string" } }, { "name": "facilityIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIsw", "type": "string" } }, { "name": "facilityNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityNisw", "type": "string" } }, { "name": "facilityIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityIe", "type": "string" } }, { "name": "facilityNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "facilityNie", "type": "string" } }, { "name": "latitudeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "latitudeN", "type": "string" } }, { "name": "latitudeLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "latitudeLte", "type": "string" } }, { "name": "latitudeLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "latitudeLt", "type": "string" } }, { "name": "latitudeGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "latitudeGte", "type": "string" } }, { "name": "latitudeGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "latitudeGt", "type": "string" } }, { "name": "longitudeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "longitudeN", "type": "string" } }, { "name": "longitudeLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "longitudeLte", "type": "string" } }, { "name": "longitudeLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "longitudeLt", "type": "string" } }, { "name": "longitudeGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "longitudeGte", "type": "string" } }, { "name": "longitudeGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "longitudeGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupN", "type": "string" } }, { "name": "asnN", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnN", "type": "string" } }, { "name": "asnIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Planned", "Staging", "Active", "Decommissioning", "Retired" ] }, "value": { "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] } } }, "region": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "group": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "facility": { "title": "Facility", "description": "Local facility ID or description", "type": "string", "maxLength": 50 }, "time_zone": { "title": "Time zone", "type": "string" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "physical_address": { "title": "Physical address", "type": "string", "maxLength": 200 }, "shipping_address": { "title": "Shipping address", "type": "string", "maxLength": 200 }, "latitude": { "title": "Latitude", "description": "GPS coordinate (latitude)", "type": "number", "x-nullable": true }, "longitude": { "title": "Longitude", "description": "GPS coordinate (longitude)", "type": "number", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "required": [ "asn" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1 } } }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimSites" }, "task": true }, { "name": "postDcimSites", "summary": "dcim_sites_create", "description": "dcim_sites_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"region\": 123, \"group\": 123, \"tenant\": 123, \"facility\": \"string\", \"time_zone\": \"string\", \"description\": \"string\", \"physical_address\": \"string\", \"shipping_address\": \"string\", \"latitude\": 123, \"longitude\": 123, \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "region": { "title": "Region", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "facility": { "title": "Facility", "description": "Local facility ID or description", "type": "string", "maxLength": 50 }, "time_zone": { "title": "Time zone", "type": "string" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "physical_address": { "title": "Physical address", "type": "string", "maxLength": 200 }, "shipping_address": { "title": "Shipping address", "type": "string", "maxLength": 200 }, "latitude": { "title": "Latitude", "description": "GPS coordinate (latitude)", "type": "number", "x-nullable": true }, "longitude": { "title": "Longitude", "description": "GPS coordinate (longitude)", "type": "number", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimSites" }, "task": true }, { "name": "putDcimSites", "summary": "dcim_sites_bulk_update", "description": "dcim_sites_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"region\": 123, \"group\": 123, \"tenant\": 123, \"facility\": \"string\", \"time_zone\": \"string\", \"description\": \"string\", \"physical_address\": \"string\", \"shipping_address\": \"string\", \"latitude\": 123, \"longitude\": 123, \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "region": { "title": "Region", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "facility": { "title": "Facility", "description": "Local facility ID or description", "type": "string", "maxLength": 50 }, "time_zone": { "title": "Time zone", "type": "string" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "physical_address": { "title": "Physical address", "type": "string", "maxLength": 200 }, "shipping_address": { "title": "Shipping address", "type": "string", "maxLength": 200 }, "latitude": { "title": "Latitude", "description": "GPS coordinate (latitude)", "type": "number", "x-nullable": true }, "longitude": { "title": "Longitude", "description": "GPS coordinate (longitude)", "type": "number", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimSites" }, "task": true }, { "name": "patchDcimSites", "summary": "dcim_sites_bulk_partial_update", "description": "dcim_sites_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"region\": 123, \"group\": 123, \"tenant\": 123, \"facility\": \"string\", \"time_zone\": \"string\", \"description\": \"string\", \"physical_address\": \"string\", \"shipping_address\": \"string\", \"latitude\": 123, \"longitude\": 123, \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "region": { "title": "Region", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "facility": { "title": "Facility", "description": "Local facility ID or description", "type": "string", "maxLength": 50 }, "time_zone": { "title": "Time zone", "type": "string" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "physical_address": { "title": "Physical address", "type": "string", "maxLength": 200 }, "shipping_address": { "title": "Shipping address", "type": "string", "maxLength": 200 }, "latitude": { "title": "Latitude", "description": "GPS coordinate (latitude)", "type": "number", "x-nullable": true }, "longitude": { "title": "Longitude", "description": "GPS coordinate (longitude)", "type": "number", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimSites" }, "task": true }, { "name": "deleteDcimSites", "summary": "dcim_sites_bulk_delete", "description": "dcim_sites_bulk_delete", "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": "/deleteDcimSites" }, "task": true }, { "name": "getDcimSitesId", "summary": "dcim_sites_read", "description": "dcim_sites_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this site.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimSitesId" }, "task": true }, { "name": "putDcimSitesId", "summary": "dcim_sites_update", "description": "dcim_sites_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this site.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"region\": 123, \"group\": 123, \"tenant\": 123, \"facility\": \"string\", \"time_zone\": \"string\", \"description\": \"string\", \"physical_address\": \"string\", \"shipping_address\": \"string\", \"latitude\": 123, \"longitude\": 123, \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "region": { "title": "Region", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "facility": { "title": "Facility", "description": "Local facility ID or description", "type": "string", "maxLength": 50 }, "time_zone": { "title": "Time zone", "type": "string" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "physical_address": { "title": "Physical address", "type": "string", "maxLength": 200 }, "shipping_address": { "title": "Shipping address", "type": "string", "maxLength": 200 }, "latitude": { "title": "Latitude", "description": "GPS coordinate (latitude)", "type": "number", "x-nullable": true }, "longitude": { "title": "Longitude", "description": "GPS coordinate (longitude)", "type": "number", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimSitesId" }, "task": true }, { "name": "patchDcimSitesId", "summary": "dcim_sites_partial_update", "description": "dcim_sites_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this site.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"status\": \"Must be one of [planned, staging, active, decommissioning, retired]\", \"region\": 123, \"group\": 123, \"tenant\": 123, \"facility\": \"string\", \"time_zone\": \"string\", \"description\": \"string\", \"physical_address\": \"string\", \"shipping_address\": \"string\", \"latitude\": 123, \"longitude\": 123, \"comments\": \"string\", \"asns\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "retired" ] }, "region": { "title": "Region", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "facility": { "title": "Facility", "description": "Local facility ID or description", "type": "string", "maxLength": 50 }, "time_zone": { "title": "Time zone", "type": "string" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "physical_address": { "title": "Physical address", "type": "string", "maxLength": 200 }, "shipping_address": { "title": "Shipping address", "type": "string", "maxLength": 200 }, "latitude": { "title": "Latitude", "description": "GPS coordinate (latitude)", "type": "number", "x-nullable": true }, "longitude": { "title": "Longitude", "description": "GPS coordinate (longitude)", "type": "number", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "asns": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimSitesId" }, "task": true }, { "name": "deleteDcimSitesId", "summary": "dcim_sites_delete", "description": "dcim_sites_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this site.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimSitesId" }, "task": true }, { "name": "getDcimVirtualChassis", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "domain", "type": "string", "info": ": string", "required": false, "schema": { "title": "domain", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "masterId", "type": "string", "info": ": string", "required": false, "schema": { "title": "masterId", "type": "string" } }, { "name": "master", "type": "string", "info": ": string", "required": false, "schema": { "title": "master", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "domainN", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainN", "type": "string" } }, { "name": "domainIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainIc", "type": "string" } }, { "name": "domainNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainNic", "type": "string" } }, { "name": "domainIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainIew", "type": "string" } }, { "name": "domainNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainNiew", "type": "string" } }, { "name": "domainIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainIsw", "type": "string" } }, { "name": "domainNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainNisw", "type": "string" } }, { "name": "domainIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainIe", "type": "string" } }, { "name": "domainNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "domainNie", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "masterIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "masterIdN", "type": "string" } }, { "name": "masterN", "type": "string", "info": ": string", "required": false, "schema": { "title": "masterN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "domain": { "title": "Domain", "type": "string", "maxLength": 30 }, "master": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "member_count": { "title": "Member count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimVirtualChassis" }, "task": true }, { "name": "postDcimVirtualChassis", "summary": "dcim_virtual-chassis_create", "description": "dcim_virtual-chassis_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"domain\": \"string\", \"master\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"member_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "domain": { "title": "Domain", "type": "string", "maxLength": 30 }, "master": { "title": "Master", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "member_count": { "title": "Member count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimVirtualChassis" }, "task": true }, { "name": "putDcimVirtualChassis", "summary": "dcim_virtual-chassis_bulk_update", "description": "dcim_virtual-chassis_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"domain\": \"string\", \"master\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"member_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "domain": { "title": "Domain", "type": "string", "maxLength": 30 }, "master": { "title": "Master", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "member_count": { "title": "Member count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimVirtualChassis" }, "task": true }, { "name": "patchDcimVirtualChassis", "summary": "dcim_virtual-chassis_bulk_partial_update", "description": "dcim_virtual-chassis_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"domain\": \"string\", \"master\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"member_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "domain": { "title": "Domain", "type": "string", "maxLength": 30 }, "master": { "title": "Master", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "member_count": { "title": "Member count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimVirtualChassis" }, "task": true }, { "name": "deleteDcimVirtualChassis", "summary": "dcim_virtual-chassis_bulk_delete", "description": "dcim_virtual-chassis_bulk_delete", "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": "/deleteDcimVirtualChassis" }, "task": true }, { "name": "getDcimVirtualChassisId", "summary": "dcim_virtual-chassis_read", "description": "dcim_virtual-chassis_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual chassis.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimVirtualChassisId" }, "task": true }, { "name": "putDcimVirtualChassisId", "summary": "dcim_virtual-chassis_update", "description": "dcim_virtual-chassis_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual chassis.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"domain\": \"string\", \"master\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"member_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "domain": { "title": "Domain", "type": "string", "maxLength": 30 }, "master": { "title": "Master", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "member_count": { "title": "Member count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimVirtualChassisId" }, "task": true }, { "name": "patchDcimVirtualChassisId", "summary": "dcim_virtual-chassis_partial_update", "description": "dcim_virtual-chassis_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual chassis.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"domain\": \"string\", \"master\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"member_count\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "domain": { "title": "Domain", "type": "string", "maxLength": 30 }, "master": { "title": "Master", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "member_count": { "title": "Member count", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimVirtualChassisId" }, "task": true }, { "name": "deleteDcimVirtualChassisId", "summary": "dcim_virtual-chassis_delete", "description": "dcim_virtual-chassis_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual chassis.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimVirtualChassisId" }, "task": true }, { "name": "getExtrasConfigContexts", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "isActive", "type": "string", "info": ": string", "required": false, "schema": { "title": "isActive", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "locationId", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationId", "type": "string" } }, { "name": "location", "type": "string", "info": ": string", "required": false, "schema": { "title": "location", "type": "string" } }, { "name": "deviceTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceTypeId", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "platformId", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformId", "type": "string" } }, { "name": "platform", "type": "string", "info": ": string", "required": false, "schema": { "title": "platform", "type": "string" } }, { "name": "clusterTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterTypeId", "type": "string" } }, { "name": "clusterType", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterType", "type": "string" } }, { "name": "clusterGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterGroupId", "type": "string" } }, { "name": "clusterGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterGroup", "type": "string" } }, { "name": "clusterId", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterId", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "tagId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagId", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "locationIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationIdN", "type": "string" } }, { "name": "locationN", "type": "string", "info": ": string", "required": false, "schema": { "title": "locationN", "type": "string" } }, { "name": "deviceTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceTypeIdN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "platformIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformIdN", "type": "string" } }, { "name": "platformN", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformN", "type": "string" } }, { "name": "clusterTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterTypeIdN", "type": "string" } }, { "name": "clusterTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterTypeN", "type": "string" } }, { "name": "clusterGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterGroupIdN", "type": "string" } }, { "name": "clusterGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterGroupN", "type": "string" } }, { "name": "clusterIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterIdN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "tagIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagIdN", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "data" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "is_active": { "title": "Is active", "type": "boolean" }, "regions": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "uniqueItems": true }, "site_groups": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "uniqueItems": true }, "sites": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "uniqueItems": true }, "locations": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "uniqueItems": true }, "device_types": { "type": "array", "items": { "required": [ "model", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "manufacturer": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "devicetype_count": { "title": "Devicetype count", "type": "integer", "readOnly": true } } }, "model": { "title": "Model", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true } } }, "uniqueItems": true }, "roles": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } } }, "uniqueItems": true }, "platforms": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "uniqueItems": true }, "cluster_types": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } } }, "uniqueItems": true }, "cluster_groups": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } } }, "uniqueItems": true }, "clusters": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "uniqueItems": true }, "tenant_groups": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } }, "uniqueItems": true }, "tenants": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "uniqueItems": true }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[-\\w]+$" }, "uniqueItems": true }, "data": { "title": "Data", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasConfigContexts" }, "task": true }, { "name": "postExtrasConfigContexts", "summary": "extras_config-contexts_create", "description": "extras_config-contexts_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"weight\": 123, \"description\": \"string\", \"is_active\": \"boolean\", \"regions\": \"array\", \"site_groups\": \"array\", \"sites\": \"array\", \"locations\": \"array\", \"device_types\": \"array\", \"roles\": \"array\", \"platforms\": \"array\", \"cluster_types\": \"array\", \"cluster_groups\": \"array\", \"clusters\": \"array\", \"tenant_groups\": \"array\", \"tenants\": \"array\", \"tags\": \"array\", \"data\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "data" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "is_active": { "title": "Is active", "type": "boolean" }, "regions": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "site_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "sites": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "locations": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "device_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "roles": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "platforms": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "clusters": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenant_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenants": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[-\\w]+$" }, "uniqueItems": true }, "data": { "title": "Data", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasConfigContexts" }, "task": true }, { "name": "putExtrasConfigContexts", "summary": "extras_config-contexts_bulk_update", "description": "extras_config-contexts_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"weight\": 123, \"description\": \"string\", \"is_active\": \"boolean\", \"regions\": \"array\", \"site_groups\": \"array\", \"sites\": \"array\", \"locations\": \"array\", \"device_types\": \"array\", \"roles\": \"array\", \"platforms\": \"array\", \"cluster_types\": \"array\", \"cluster_groups\": \"array\", \"clusters\": \"array\", \"tenant_groups\": \"array\", \"tenants\": \"array\", \"tags\": \"array\", \"data\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "data" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "is_active": { "title": "Is active", "type": "boolean" }, "regions": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "site_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "sites": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "locations": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "device_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "roles": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "platforms": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "clusters": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenant_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenants": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[-\\w]+$" }, "uniqueItems": true }, "data": { "title": "Data", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasConfigContexts" }, "task": true }, { "name": "patchExtrasConfigContexts", "summary": "extras_config-contexts_bulk_partial_update", "description": "extras_config-contexts_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"weight\": 123, \"description\": \"string\", \"is_active\": \"boolean\", \"regions\": \"array\", \"site_groups\": \"array\", \"sites\": \"array\", \"locations\": \"array\", \"device_types\": \"array\", \"roles\": \"array\", \"platforms\": \"array\", \"cluster_types\": \"array\", \"cluster_groups\": \"array\", \"clusters\": \"array\", \"tenant_groups\": \"array\", \"tenants\": \"array\", \"tags\": \"array\", \"data\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "data" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "is_active": { "title": "Is active", "type": "boolean" }, "regions": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "site_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "sites": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "locations": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "device_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "roles": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "platforms": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "clusters": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenant_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenants": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[-\\w]+$" }, "uniqueItems": true }, "data": { "title": "Data", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasConfigContexts" }, "task": true }, { "name": "deleteExtrasConfigContexts", "summary": "extras_config-contexts_bulk_delete", "description": "extras_config-contexts_bulk_delete", "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": "/deleteExtrasConfigContexts" }, "task": true }, { "name": "getExtrasConfigContextsId", "summary": "extras_config-contexts_read", "description": "extras_config-contexts_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this config context.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasConfigContextsId" }, "task": true }, { "name": "putExtrasConfigContextsId", "summary": "extras_config-contexts_update", "description": "extras_config-contexts_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this config context.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"weight\": 123, \"description\": \"string\", \"is_active\": \"boolean\", \"regions\": \"array\", \"site_groups\": \"array\", \"sites\": \"array\", \"locations\": \"array\", \"device_types\": \"array\", \"roles\": \"array\", \"platforms\": \"array\", \"cluster_types\": \"array\", \"cluster_groups\": \"array\", \"clusters\": \"array\", \"tenant_groups\": \"array\", \"tenants\": \"array\", \"tags\": \"array\", \"data\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "data" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "is_active": { "title": "Is active", "type": "boolean" }, "regions": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "site_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "sites": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "locations": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "device_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "roles": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "platforms": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "clusters": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenant_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenants": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[-\\w]+$" }, "uniqueItems": true }, "data": { "title": "Data", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasConfigContextsId" }, "task": true }, { "name": "patchExtrasConfigContextsId", "summary": "extras_config-contexts_partial_update", "description": "extras_config-contexts_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this config context.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"weight\": 123, \"description\": \"string\", \"is_active\": \"boolean\", \"regions\": \"array\", \"site_groups\": \"array\", \"sites\": \"array\", \"locations\": \"array\", \"device_types\": \"array\", \"roles\": \"array\", \"platforms\": \"array\", \"cluster_types\": \"array\", \"cluster_groups\": \"array\", \"clusters\": \"array\", \"tenant_groups\": \"array\", \"tenants\": \"array\", \"tags\": \"array\", \"data\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "data" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "is_active": { "title": "Is active", "type": "boolean" }, "regions": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "site_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "sites": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "locations": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "device_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "roles": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "platforms": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_types": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "cluster_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "clusters": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenant_groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tenants": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[-\\w]+$" }, "uniqueItems": true }, "data": { "title": "Data", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasConfigContextsId" }, "task": true }, { "name": "deleteExtrasConfigContextsId", "summary": "extras_config-contexts_delete", "description": "extras_config-contexts_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this config context.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasConfigContextsId" }, "task": true }, { "name": "getExtrasContentTypes", "summary": "Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.", "description": "Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.", "input": [ { "name": "id", "type": "number", "info": ": 123", "required": false, "schema": { "title": "id", "type": "number" } }, { "name": "appLabel", "type": "string", "info": ": string", "required": false, "schema": { "title": "appLabel", "type": "string" } }, { "name": "model", "type": "string", "info": ": string", "required": false, "schema": { "title": "model", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "app_label", "model" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "app_label": { "title": "App label", "type": "string", "maxLength": 100, "minLength": 1 }, "model": { "title": "Python model class name", "type": "string", "maxLength": 100, "minLength": 1 } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasContentTypes" }, "task": true }, { "name": "getExtrasContentTypesId", "summary": "Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.", "description": "Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this content type.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasContentTypesId" }, "task": true }, { "name": "getExtrasCustomFields", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "contentTypes", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypes", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "groupName", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "required", "type": "string", "info": ": string", "required": false, "schema": { "title": "required", "type": "string" } }, { "name": "filterLogic", "type": "string", "info": ": string", "required": false, "schema": { "title": "filterLogic", "type": "string" } }, { "name": "uiVisibility", "type": "string", "info": ": string", "required": false, "schema": { "title": "uiVisibility", "type": "string" } }, { "name": "weight", "type": "string", "info": ": string", "required": false, "schema": { "title": "weight", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "contentTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "contentTypesN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesN", "type": "string" } }, { "name": "contentTypesIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIc", "type": "string" } }, { "name": "contentTypesNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNic", "type": "string" } }, { "name": "contentTypesIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIew", "type": "string" } }, { "name": "contentTypesNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNiew", "type": "string" } }, { "name": "contentTypesIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIsw", "type": "string" } }, { "name": "contentTypesNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNisw", "type": "string" } }, { "name": "contentTypesIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIe", "type": "string" } }, { "name": "contentTypesNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNie", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "groupNameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameN", "type": "string" } }, { "name": "groupNameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameIc", "type": "string" } }, { "name": "groupNameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameNic", "type": "string" } }, { "name": "groupNameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameIew", "type": "string" } }, { "name": "groupNameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameNiew", "type": "string" } }, { "name": "groupNameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameIsw", "type": "string" } }, { "name": "groupNameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameNisw", "type": "string" } }, { "name": "groupNameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameIe", "type": "string" } }, { "name": "groupNameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameNie", "type": "string" } }, { "name": "filterLogicN", "type": "string", "info": ": string", "required": false, "schema": { "title": "filterLogicN", "type": "string" } }, { "name": "uiVisibilityN", "type": "string", "info": ": string", "required": false, "schema": { "title": "uiVisibilityN", "type": "string" } }, { "name": "weightN", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightN", "type": "string" } }, { "name": "weightLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightLte", "type": "string" } }, { "name": "weightLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightLt", "type": "string" } }, { "name": "weightGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightGte", "type": "string" } }, { "name": "weightGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "contentTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdN", "type": "string" } }, { "name": "contentTypeIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdLte", "type": "string" } }, { "name": "contentTypeIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdLt", "type": "string" } }, { "name": "contentTypeIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdGte", "type": "string" } }, { "name": "contentTypeIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdGt", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "content_types", "type", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Text", "Text (long)", "Integer", "Boolean (true/false)", "Date", "URL", "JSON", "Selection", "Multiple selection", "Object", "Multiple objects" ] }, "value": { "type": "string", "enum": [ "text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect", "object", "multiobject" ] } } }, "object_type": { "title": "Object type", "type": "string" }, "data_type": { "title": "Data type", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Internal field name", "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 50, "minLength": 1 }, "label": { "title": "Label", "description": "Name of the field as displayed to users (if not provided, the field's name will be used)", "type": "string", "maxLength": 50 }, "group_name": { "title": "Group name", "description": "Custom fields within the same group will be displayed together", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "required": { "title": "Required", "description": "If true, this field is required when creating new objects or editing an existing object.", "type": "boolean" }, "filter_logic": { "title": "Filter logic", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Disabled", "Loose", "Exact" ] }, "value": { "type": "string", "enum": [ "disabled", "loose", "exact" ] } } }, "ui_visibility": { "title": "Ui visibility", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Read/Write", "Read-only", "Hidden" ] }, "value": { "type": "string", "enum": [ "read-write", "read-only", "hidden" ] } } }, "default": { "title": "Default", "description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\").", "type": "object", "x-nullable": true }, "weight": { "title": "Weight", "description": "Fields with higher weights appear lower in a form.", "type": "integer", "maximum": 32767, "minimum": 0 }, "validation_minimum": { "title": "Minimum value", "description": "Minimum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_maximum": { "title": "Maximum value", "description": "Maximum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_regex": { "title": "Validation regex", "description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.", "type": "string", "maxLength": 500 }, "choices": { "description": "Comma-separated list of available choices (for selection fields)", "type": "array", "items": { "title": "Choices", "type": "string", "maxLength": 100, "minLength": 1 }, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasCustomFields" }, "task": true }, { "name": "postExtrasCustomFields", "summary": "extras_custom-fields_create", "description": "extras_custom-fields_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"type\": \"Must be one of [text, longtext, integer, boolean, date, url, json, select, multiselect, object, multiobject]\", \"object_type\": \"string\", \"data_type\": \"string\", \"name\": \"string\", \"label\": \"string\", \"group_name\": \"string\", \"description\": \"string\", \"required\": \"boolean\", \"filter_logic\": \"Must be one of [disabled, loose, exact]\", \"ui_visibility\": \"Must be one of [read-write, read-only, hidden]\", \"default\": \"object\", \"weight\": 123, \"validation_minimum\": 123, \"validation_maximum\": 123, \"validation_regex\": \"string\", \"choices\": \"array\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "type": { "title": "Type", "description": "The type of data this custom field holds", "type": "string", "enum": [ "text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect", "object", "multiobject" ] }, "object_type": { "title": "Object type", "type": "string" }, "data_type": { "title": "Data type", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Internal field name", "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 50, "minLength": 1 }, "label": { "title": "Label", "description": "Name of the field as displayed to users (if not provided, the field's name will be used)", "type": "string", "maxLength": 50 }, "group_name": { "title": "Group name", "description": "Custom fields within the same group will be displayed together", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "required": { "title": "Required", "description": "If true, this field is required when creating new objects or editing an existing object.", "type": "boolean" }, "filter_logic": { "title": "Filter logic", "description": "Loose matches any instance of a given string; exact matches the entire field.", "type": "string", "enum": [ "disabled", "loose", "exact" ] }, "ui_visibility": { "title": "UI visibility", "description": "Specifies the visibility of custom field in the UI", "type": "string", "enum": [ "read-write", "read-only", "hidden" ] }, "default": { "title": "Default", "description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\").", "type": "object", "x-nullable": true }, "weight": { "title": "Weight", "description": "Fields with higher weights appear lower in a form.", "type": "integer", "maximum": 32767, "minimum": 0 }, "validation_minimum": { "title": "Minimum value", "description": "Minimum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_maximum": { "title": "Maximum value", "description": "Maximum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_regex": { "title": "Validation regex", "description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.", "type": "string", "maxLength": 500 }, "choices": { "description": "Comma-separated list of available choices (for selection fields)", "type": "array", "items": { "title": "Choices", "type": "string", "maxLength": 100, "minLength": 1 }, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasCustomFields" }, "task": true }, { "name": "putExtrasCustomFields", "summary": "extras_custom-fields_bulk_update", "description": "extras_custom-fields_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"type\": \"Must be one of [text, longtext, integer, boolean, date, url, json, select, multiselect, object, multiobject]\", \"object_type\": \"string\", \"data_type\": \"string\", \"name\": \"string\", \"label\": \"string\", \"group_name\": \"string\", \"description\": \"string\", \"required\": \"boolean\", \"filter_logic\": \"Must be one of [disabled, loose, exact]\", \"ui_visibility\": \"Must be one of [read-write, read-only, hidden]\", \"default\": \"object\", \"weight\": 123, \"validation_minimum\": 123, \"validation_maximum\": 123, \"validation_regex\": \"string\", \"choices\": \"array\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "type": { "title": "Type", "description": "The type of data this custom field holds", "type": "string", "enum": [ "text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect", "object", "multiobject" ] }, "object_type": { "title": "Object type", "type": "string" }, "data_type": { "title": "Data type", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Internal field name", "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 50, "minLength": 1 }, "label": { "title": "Label", "description": "Name of the field as displayed to users (if not provided, the field's name will be used)", "type": "string", "maxLength": 50 }, "group_name": { "title": "Group name", "description": "Custom fields within the same group will be displayed together", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "required": { "title": "Required", "description": "If true, this field is required when creating new objects or editing an existing object.", "type": "boolean" }, "filter_logic": { "title": "Filter logic", "description": "Loose matches any instance of a given string; exact matches the entire field.", "type": "string", "enum": [ "disabled", "loose", "exact" ] }, "ui_visibility": { "title": "UI visibility", "description": "Specifies the visibility of custom field in the UI", "type": "string", "enum": [ "read-write", "read-only", "hidden" ] }, "default": { "title": "Default", "description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\").", "type": "object", "x-nullable": true }, "weight": { "title": "Weight", "description": "Fields with higher weights appear lower in a form.", "type": "integer", "maximum": 32767, "minimum": 0 }, "validation_minimum": { "title": "Minimum value", "description": "Minimum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_maximum": { "title": "Maximum value", "description": "Maximum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_regex": { "title": "Validation regex", "description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.", "type": "string", "maxLength": 500 }, "choices": { "description": "Comma-separated list of available choices (for selection fields)", "type": "array", "items": { "title": "Choices", "type": "string", "maxLength": 100, "minLength": 1 }, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasCustomFields" }, "task": true }, { "name": "patchExtrasCustomFields", "summary": "extras_custom-fields_bulk_partial_update", "description": "extras_custom-fields_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"type\": \"Must be one of [text, longtext, integer, boolean, date, url, json, select, multiselect, object, multiobject]\", \"object_type\": \"string\", \"data_type\": \"string\", \"name\": \"string\", \"label\": \"string\", \"group_name\": \"string\", \"description\": \"string\", \"required\": \"boolean\", \"filter_logic\": \"Must be one of [disabled, loose, exact]\", \"ui_visibility\": \"Must be one of [read-write, read-only, hidden]\", \"default\": \"object\", \"weight\": 123, \"validation_minimum\": 123, \"validation_maximum\": 123, \"validation_regex\": \"string\", \"choices\": \"array\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "type": { "title": "Type", "description": "The type of data this custom field holds", "type": "string", "enum": [ "text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect", "object", "multiobject" ] }, "object_type": { "title": "Object type", "type": "string" }, "data_type": { "title": "Data type", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Internal field name", "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 50, "minLength": 1 }, "label": { "title": "Label", "description": "Name of the field as displayed to users (if not provided, the field's name will be used)", "type": "string", "maxLength": 50 }, "group_name": { "title": "Group name", "description": "Custom fields within the same group will be displayed together", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "required": { "title": "Required", "description": "If true, this field is required when creating new objects or editing an existing object.", "type": "boolean" }, "filter_logic": { "title": "Filter logic", "description": "Loose matches any instance of a given string; exact matches the entire field.", "type": "string", "enum": [ "disabled", "loose", "exact" ] }, "ui_visibility": { "title": "UI visibility", "description": "Specifies the visibility of custom field in the UI", "type": "string", "enum": [ "read-write", "read-only", "hidden" ] }, "default": { "title": "Default", "description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\").", "type": "object", "x-nullable": true }, "weight": { "title": "Weight", "description": "Fields with higher weights appear lower in a form.", "type": "integer", "maximum": 32767, "minimum": 0 }, "validation_minimum": { "title": "Minimum value", "description": "Minimum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_maximum": { "title": "Maximum value", "description": "Maximum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_regex": { "title": "Validation regex", "description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.", "type": "string", "maxLength": 500 }, "choices": { "description": "Comma-separated list of available choices (for selection fields)", "type": "array", "items": { "title": "Choices", "type": "string", "maxLength": 100, "minLength": 1 }, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasCustomFields" }, "task": true }, { "name": "deleteExtrasCustomFields", "summary": "extras_custom-fields_bulk_delete", "description": "extras_custom-fields_bulk_delete", "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": "/deleteExtrasCustomFields" }, "task": true }, { "name": "getExtrasCustomFieldsId", "summary": "extras_custom-fields_read", "description": "extras_custom-fields_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom field.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasCustomFieldsId" }, "task": true }, { "name": "putExtrasCustomFieldsId", "summary": "extras_custom-fields_update", "description": "extras_custom-fields_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom field.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"type\": \"Must be one of [text, longtext, integer, boolean, date, url, json, select, multiselect, object, multiobject]\", \"object_type\": \"string\", \"data_type\": \"string\", \"name\": \"string\", \"label\": \"string\", \"group_name\": \"string\", \"description\": \"string\", \"required\": \"boolean\", \"filter_logic\": \"Must be one of [disabled, loose, exact]\", \"ui_visibility\": \"Must be one of [read-write, read-only, hidden]\", \"default\": \"object\", \"weight\": 123, \"validation_minimum\": 123, \"validation_maximum\": 123, \"validation_regex\": \"string\", \"choices\": \"array\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "type": { "title": "Type", "description": "The type of data this custom field holds", "type": "string", "enum": [ "text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect", "object", "multiobject" ] }, "object_type": { "title": "Object type", "type": "string" }, "data_type": { "title": "Data type", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Internal field name", "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 50, "minLength": 1 }, "label": { "title": "Label", "description": "Name of the field as displayed to users (if not provided, the field's name will be used)", "type": "string", "maxLength": 50 }, "group_name": { "title": "Group name", "description": "Custom fields within the same group will be displayed together", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "required": { "title": "Required", "description": "If true, this field is required when creating new objects or editing an existing object.", "type": "boolean" }, "filter_logic": { "title": "Filter logic", "description": "Loose matches any instance of a given string; exact matches the entire field.", "type": "string", "enum": [ "disabled", "loose", "exact" ] }, "ui_visibility": { "title": "UI visibility", "description": "Specifies the visibility of custom field in the UI", "type": "string", "enum": [ "read-write", "read-only", "hidden" ] }, "default": { "title": "Default", "description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\").", "type": "object", "x-nullable": true }, "weight": { "title": "Weight", "description": "Fields with higher weights appear lower in a form.", "type": "integer", "maximum": 32767, "minimum": 0 }, "validation_minimum": { "title": "Minimum value", "description": "Minimum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_maximum": { "title": "Maximum value", "description": "Maximum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_regex": { "title": "Validation regex", "description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.", "type": "string", "maxLength": 500 }, "choices": { "description": "Comma-separated list of available choices (for selection fields)", "type": "array", "items": { "title": "Choices", "type": "string", "maxLength": 100, "minLength": 1 }, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasCustomFieldsId" }, "task": true }, { "name": "patchExtrasCustomFieldsId", "summary": "extras_custom-fields_partial_update", "description": "extras_custom-fields_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom field.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"type\": \"Must be one of [text, longtext, integer, boolean, date, url, json, select, multiselect, object, multiobject]\", \"object_type\": \"string\", \"data_type\": \"string\", \"name\": \"string\", \"label\": \"string\", \"group_name\": \"string\", \"description\": \"string\", \"required\": \"boolean\", \"filter_logic\": \"Must be one of [disabled, loose, exact]\", \"ui_visibility\": \"Must be one of [read-write, read-only, hidden]\", \"default\": \"object\", \"weight\": 123, \"validation_minimum\": 123, \"validation_maximum\": 123, \"validation_regex\": \"string\", \"choices\": \"array\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "type": { "title": "Type", "description": "The type of data this custom field holds", "type": "string", "enum": [ "text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect", "object", "multiobject" ] }, "object_type": { "title": "Object type", "type": "string" }, "data_type": { "title": "Data type", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Internal field name", "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 50, "minLength": 1 }, "label": { "title": "Label", "description": "Name of the field as displayed to users (if not provided, the field's name will be used)", "type": "string", "maxLength": 50 }, "group_name": { "title": "Group name", "description": "Custom fields within the same group will be displayed together", "type": "string", "maxLength": 50 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "required": { "title": "Required", "description": "If true, this field is required when creating new objects or editing an existing object.", "type": "boolean" }, "filter_logic": { "title": "Filter logic", "description": "Loose matches any instance of a given string; exact matches the entire field.", "type": "string", "enum": [ "disabled", "loose", "exact" ] }, "ui_visibility": { "title": "UI visibility", "description": "Specifies the visibility of custom field in the UI", "type": "string", "enum": [ "read-write", "read-only", "hidden" ] }, "default": { "title": "Default", "description": "Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. \"Foo\").", "type": "object", "x-nullable": true }, "weight": { "title": "Weight", "description": "Fields with higher weights appear lower in a form.", "type": "integer", "maximum": 32767, "minimum": 0 }, "validation_minimum": { "title": "Minimum value", "description": "Minimum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_maximum": { "title": "Maximum value", "description": "Maximum allowed value (for numeric fields)", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true }, "validation_regex": { "title": "Validation regex", "description": "Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.", "type": "string", "maxLength": 500 }, "choices": { "description": "Comma-separated list of available choices (for selection fields)", "type": "array", "items": { "title": "Choices", "type": "string", "maxLength": 100, "minLength": 1 }, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasCustomFieldsId" }, "task": true }, { "name": "deleteExtrasCustomFieldsId", "summary": "extras_custom-fields_delete", "description": "extras_custom-fields_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom field.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasCustomFieldsId" }, "task": true }, { "name": "getExtrasCustomLinks", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "contentType", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentType", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "enabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "enabled", "type": "string" } }, { "name": "linkText", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkText", "type": "string" } }, { "name": "linkUrl", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrl", "type": "string" } }, { "name": "weight", "type": "string", "info": ": string", "required": false, "schema": { "title": "weight", "type": "string" } }, { "name": "groupName", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupName", "type": "string" } }, { "name": "newWindow", "type": "string", "info": ": string", "required": false, "schema": { "title": "newWindow", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "contentTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeN", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "linkTextN", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextN", "type": "string" } }, { "name": "linkTextIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextIc", "type": "string" } }, { "name": "linkTextNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextNic", "type": "string" } }, { "name": "linkTextIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextIew", "type": "string" } }, { "name": "linkTextNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextNiew", "type": "string" } }, { "name": "linkTextIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextIsw", "type": "string" } }, { "name": "linkTextNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextNisw", "type": "string" } }, { "name": "linkTextIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextIe", "type": "string" } }, { "name": "linkTextNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkTextNie", "type": "string" } }, { "name": "linkUrlN", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlN", "type": "string" } }, { "name": "linkUrlIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlIc", "type": "string" } }, { "name": "linkUrlNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlNic", "type": "string" } }, { "name": "linkUrlIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlIew", "type": "string" } }, { "name": "linkUrlNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlNiew", "type": "string" } }, { "name": "linkUrlIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlIsw", "type": "string" } }, { "name": "linkUrlNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlNisw", "type": "string" } }, { "name": "linkUrlIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlIe", "type": "string" } }, { "name": "linkUrlNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkUrlNie", "type": "string" } }, { "name": "weightN", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightN", "type": "string" } }, { "name": "weightLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightLte", "type": "string" } }, { "name": "weightLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightLt", "type": "string" } }, { "name": "weightGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightGte", "type": "string" } }, { "name": "weightGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightGt", "type": "string" } }, { "name": "groupNameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameN", "type": "string" } }, { "name": "groupNameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameIc", "type": "string" } }, { "name": "groupNameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameNic", "type": "string" } }, { "name": "groupNameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameIew", "type": "string" } }, { "name": "groupNameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameNiew", "type": "string" } }, { "name": "groupNameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameIsw", "type": "string" } }, { "name": "groupNameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameNisw", "type": "string" } }, { "name": "groupNameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameIe", "type": "string" } }, { "name": "groupNameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupNameNie", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "content_type", "name", "link_text", "link_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "link_text": { "title": "Link text", "description": "Jinja2 template code for link text", "type": "string", "minLength": 1 }, "link_url": { "title": "Link URL", "description": "Jinja2 template code for link URL", "type": "string", "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "group_name": { "title": "Group name", "description": "Links with the same group will appear as a dropdown menu", "type": "string", "maxLength": 50 }, "button_class": { "title": "Button class", "description": "The class of the first link in a group will be used for the dropdown button", "type": "string", "enum": [ "outline-dark", "blue", "indigo", "purple", "pink", "red", "orange", "yellow", "green", "teal", "cyan", "gray", "black", "white", "ghost-dark" ] }, "new_window": { "title": "New window", "description": "Force link to open in a new window", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasCustomLinks" }, "task": true }, { "name": "postExtrasCustomLinks", "summary": "extras_custom-links_create", "description": "extras_custom-links_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"enabled\": \"boolean\", \"link_text\": \"string\", \"link_url\": \"string\", \"weight\": 123, \"group_name\": \"string\", \"button_class\": \"Must be one of [outline-dark, blue, indigo, purple, pink, red, orange, yellow, green, teal, cyan, gray, black, white, ghost-dark]\", \"new_window\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "link_text", "link_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "link_text": { "title": "Link text", "description": "Jinja2 template code for link text", "type": "string", "minLength": 1 }, "link_url": { "title": "Link URL", "description": "Jinja2 template code for link URL", "type": "string", "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "group_name": { "title": "Group name", "description": "Links with the same group will appear as a dropdown menu", "type": "string", "maxLength": 50 }, "button_class": { "title": "Button class", "description": "The class of the first link in a group will be used for the dropdown button", "type": "string", "enum": [ "outline-dark", "blue", "indigo", "purple", "pink", "red", "orange", "yellow", "green", "teal", "cyan", "gray", "black", "white", "ghost-dark" ] }, "new_window": { "title": "New window", "description": "Force link to open in a new window", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasCustomLinks" }, "task": true }, { "name": "putExtrasCustomLinks", "summary": "extras_custom-links_bulk_update", "description": "extras_custom-links_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"enabled\": \"boolean\", \"link_text\": \"string\", \"link_url\": \"string\", \"weight\": 123, \"group_name\": \"string\", \"button_class\": \"Must be one of [outline-dark, blue, indigo, purple, pink, red, orange, yellow, green, teal, cyan, gray, black, white, ghost-dark]\", \"new_window\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "link_text", "link_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "link_text": { "title": "Link text", "description": "Jinja2 template code for link text", "type": "string", "minLength": 1 }, "link_url": { "title": "Link URL", "description": "Jinja2 template code for link URL", "type": "string", "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "group_name": { "title": "Group name", "description": "Links with the same group will appear as a dropdown menu", "type": "string", "maxLength": 50 }, "button_class": { "title": "Button class", "description": "The class of the first link in a group will be used for the dropdown button", "type": "string", "enum": [ "outline-dark", "blue", "indigo", "purple", "pink", "red", "orange", "yellow", "green", "teal", "cyan", "gray", "black", "white", "ghost-dark" ] }, "new_window": { "title": "New window", "description": "Force link to open in a new window", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasCustomLinks" }, "task": true }, { "name": "patchExtrasCustomLinks", "summary": "extras_custom-links_bulk_partial_update", "description": "extras_custom-links_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"enabled\": \"boolean\", \"link_text\": \"string\", \"link_url\": \"string\", \"weight\": 123, \"group_name\": \"string\", \"button_class\": \"Must be one of [outline-dark, blue, indigo, purple, pink, red, orange, yellow, green, teal, cyan, gray, black, white, ghost-dark]\", \"new_window\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "link_text", "link_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "link_text": { "title": "Link text", "description": "Jinja2 template code for link text", "type": "string", "minLength": 1 }, "link_url": { "title": "Link URL", "description": "Jinja2 template code for link URL", "type": "string", "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "group_name": { "title": "Group name", "description": "Links with the same group will appear as a dropdown menu", "type": "string", "maxLength": 50 }, "button_class": { "title": "Button class", "description": "The class of the first link in a group will be used for the dropdown button", "type": "string", "enum": [ "outline-dark", "blue", "indigo", "purple", "pink", "red", "orange", "yellow", "green", "teal", "cyan", "gray", "black", "white", "ghost-dark" ] }, "new_window": { "title": "New window", "description": "Force link to open in a new window", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasCustomLinks" }, "task": true }, { "name": "deleteExtrasCustomLinks", "summary": "extras_custom-links_bulk_delete", "description": "extras_custom-links_bulk_delete", "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": "/deleteExtrasCustomLinks" }, "task": true }, { "name": "getExtrasCustomLinksId", "summary": "extras_custom-links_read", "description": "extras_custom-links_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom link.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasCustomLinksId" }, "task": true }, { "name": "putExtrasCustomLinksId", "summary": "extras_custom-links_update", "description": "extras_custom-links_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom link.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"enabled\": \"boolean\", \"link_text\": \"string\", \"link_url\": \"string\", \"weight\": 123, \"group_name\": \"string\", \"button_class\": \"Must be one of [outline-dark, blue, indigo, purple, pink, red, orange, yellow, green, teal, cyan, gray, black, white, ghost-dark]\", \"new_window\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "link_text", "link_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "link_text": { "title": "Link text", "description": "Jinja2 template code for link text", "type": "string", "minLength": 1 }, "link_url": { "title": "Link URL", "description": "Jinja2 template code for link URL", "type": "string", "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "group_name": { "title": "Group name", "description": "Links with the same group will appear as a dropdown menu", "type": "string", "maxLength": 50 }, "button_class": { "title": "Button class", "description": "The class of the first link in a group will be used for the dropdown button", "type": "string", "enum": [ "outline-dark", "blue", "indigo", "purple", "pink", "red", "orange", "yellow", "green", "teal", "cyan", "gray", "black", "white", "ghost-dark" ] }, "new_window": { "title": "New window", "description": "Force link to open in a new window", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasCustomLinksId" }, "task": true }, { "name": "patchExtrasCustomLinksId", "summary": "extras_custom-links_partial_update", "description": "extras_custom-links_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom link.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"enabled\": \"boolean\", \"link_text\": \"string\", \"link_url\": \"string\", \"weight\": 123, \"group_name\": \"string\", \"button_class\": \"Must be one of [outline-dark, blue, indigo, purple, pink, red, orange, yellow, green, teal, cyan, gray, black, white, ghost-dark]\", \"new_window\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "link_text", "link_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "link_text": { "title": "Link text", "description": "Jinja2 template code for link text", "type": "string", "minLength": 1 }, "link_url": { "title": "Link URL", "description": "Jinja2 template code for link URL", "type": "string", "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "group_name": { "title": "Group name", "description": "Links with the same group will appear as a dropdown menu", "type": "string", "maxLength": 50 }, "button_class": { "title": "Button class", "description": "The class of the first link in a group will be used for the dropdown button", "type": "string", "enum": [ "outline-dark", "blue", "indigo", "purple", "pink", "red", "orange", "yellow", "green", "teal", "cyan", "gray", "black", "white", "ghost-dark" ] }, "new_window": { "title": "New window", "description": "Force link to open in a new window", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasCustomLinksId" }, "task": true }, { "name": "deleteExtrasCustomLinksId", "summary": "extras_custom-links_delete", "description": "extras_custom-links_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom link.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasCustomLinksId" }, "task": true }, { "name": "getExtrasExportTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "contentType", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentType", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "contentTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeN", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "content_type", "name", "template_code" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "template_code": { "title": "Template code", "description": "Jinja2 template code. The list of objects being exported is passed as a context variable named queryset.", "type": "string", "minLength": 1 }, "mime_type": { "title": "MIME type", "description": "Defaults to text/plain", "type": "string", "maxLength": 50 }, "file_extension": { "title": "File extension", "description": "Extension to append to the rendered filename", "type": "string", "maxLength": 15 }, "as_attachment": { "title": "As attachment", "description": "Download file as attachment", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasExportTemplates" }, "task": true }, { "name": "postExtrasExportTemplates", "summary": "extras_export-templates_create", "description": "extras_export-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"description\": \"string\", \"template_code\": \"string\", \"mime_type\": \"string\", \"file_extension\": \"string\", \"as_attachment\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "template_code" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "template_code": { "title": "Template code", "description": "Jinja2 template code. The list of objects being exported is passed as a context variable named queryset.", "type": "string", "minLength": 1 }, "mime_type": { "title": "MIME type", "description": "Defaults to text/plain", "type": "string", "maxLength": 50 }, "file_extension": { "title": "File extension", "description": "Extension to append to the rendered filename", "type": "string", "maxLength": 15 }, "as_attachment": { "title": "As attachment", "description": "Download file as attachment", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasExportTemplates" }, "task": true }, { "name": "putExtrasExportTemplates", "summary": "extras_export-templates_bulk_update", "description": "extras_export-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"description\": \"string\", \"template_code\": \"string\", \"mime_type\": \"string\", \"file_extension\": \"string\", \"as_attachment\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "template_code" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "template_code": { "title": "Template code", "description": "Jinja2 template code. The list of objects being exported is passed as a context variable named queryset.", "type": "string", "minLength": 1 }, "mime_type": { "title": "MIME type", "description": "Defaults to text/plain", "type": "string", "maxLength": 50 }, "file_extension": { "title": "File extension", "description": "Extension to append to the rendered filename", "type": "string", "maxLength": 15 }, "as_attachment": { "title": "As attachment", "description": "Download file as attachment", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasExportTemplates" }, "task": true }, { "name": "patchExtrasExportTemplates", "summary": "extras_export-templates_bulk_partial_update", "description": "extras_export-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"description\": \"string\", \"template_code\": \"string\", \"mime_type\": \"string\", \"file_extension\": \"string\", \"as_attachment\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "template_code" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "template_code": { "title": "Template code", "description": "Jinja2 template code. The list of objects being exported is passed as a context variable named queryset.", "type": "string", "minLength": 1 }, "mime_type": { "title": "MIME type", "description": "Defaults to text/plain", "type": "string", "maxLength": 50 }, "file_extension": { "title": "File extension", "description": "Extension to append to the rendered filename", "type": "string", "maxLength": 15 }, "as_attachment": { "title": "As attachment", "description": "Download file as attachment", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasExportTemplates" }, "task": true }, { "name": "deleteExtrasExportTemplates", "summary": "extras_export-templates_bulk_delete", "description": "extras_export-templates_bulk_delete", "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": "/deleteExtrasExportTemplates" }, "task": true }, { "name": "getExtrasExportTemplatesId", "summary": "extras_export-templates_read", "description": "extras_export-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this export template.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasExportTemplatesId" }, "task": true }, { "name": "putExtrasExportTemplatesId", "summary": "extras_export-templates_update", "description": "extras_export-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this export template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"description\": \"string\", \"template_code\": \"string\", \"mime_type\": \"string\", \"file_extension\": \"string\", \"as_attachment\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "template_code" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "template_code": { "title": "Template code", "description": "Jinja2 template code. The list of objects being exported is passed as a context variable named queryset.", "type": "string", "minLength": 1 }, "mime_type": { "title": "MIME type", "description": "Defaults to text/plain", "type": "string", "maxLength": 50 }, "file_extension": { "title": "File extension", "description": "Extension to append to the rendered filename", "type": "string", "maxLength": 15 }, "as_attachment": { "title": "As attachment", "description": "Download file as attachment", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasExportTemplatesId" }, "task": true }, { "name": "patchExtrasExportTemplatesId", "summary": "extras_export-templates_partial_update", "description": "extras_export-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this export template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"name\": \"string\", \"description\": \"string\", \"template_code\": \"string\", \"mime_type\": \"string\", \"file_extension\": \"string\", \"as_attachment\": \"boolean\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "name", "template_code" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "template_code": { "title": "Template code", "description": "Jinja2 template code. The list of objects being exported is passed as a context variable named queryset.", "type": "string", "minLength": 1 }, "mime_type": { "title": "MIME type", "description": "Defaults to text/plain", "type": "string", "maxLength": 50 }, "file_extension": { "title": "File extension", "description": "Extension to append to the rendered filename", "type": "string", "maxLength": 15 }, "as_attachment": { "title": "As attachment", "description": "Download file as attachment", "type": "boolean" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasExportTemplatesId" }, "task": true }, { "name": "deleteExtrasExportTemplatesId", "summary": "extras_export-templates_delete", "description": "extras_export-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this export template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasExportTemplatesId" }, "task": true }, { "name": "getExtrasImageAttachments", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "contentTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeId", "type": "string" } }, { "name": "objectId", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectId", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "contentType", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentType", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "contentTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdN", "type": "string" } }, { "name": "objectIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdN", "type": "string" } }, { "name": "objectIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdLte", "type": "string" } }, { "name": "objectIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdLt", "type": "string" } }, { "name": "objectIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdGte", "type": "string" } }, { "name": "objectIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "contentTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "content_type", "object_id", "image_height", "image_width" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "parent": { "title": "Parent", "type": "object", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 50 }, "image": { "title": "Image", "type": "string", "readOnly": true }, "image_height": { "title": "Image height", "type": "integer", "maximum": 32767, "minimum": 0 }, "image_width": { "title": "Image width", "type": "integer", "maximum": 32767, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasImageAttachments" }, "task": true }, { "name": "postExtrasImageAttachments", "summary": "extras_image-attachments_create", "description": "extras_image-attachments_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"parent\": \"object\", \"name\": \"string\", \"image\": \"string\", \"image_height\": 123, \"image_width\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "image_height", "image_width" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "parent": { "title": "Parent", "type": "object", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 50 }, "image": { "title": "Image", "type": "string", "readOnly": true }, "image_height": { "title": "Image height", "type": "integer", "maximum": 32767, "minimum": 0 }, "image_width": { "title": "Image width", "type": "integer", "maximum": 32767, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasImageAttachments" }, "task": true }, { "name": "putExtrasImageAttachments", "summary": "extras_image-attachments_bulk_update", "description": "extras_image-attachments_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"parent\": \"object\", \"name\": \"string\", \"image\": \"string\", \"image_height\": 123, \"image_width\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "image_height", "image_width" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "parent": { "title": "Parent", "type": "object", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 50 }, "image": { "title": "Image", "type": "string", "readOnly": true }, "image_height": { "title": "Image height", "type": "integer", "maximum": 32767, "minimum": 0 }, "image_width": { "title": "Image width", "type": "integer", "maximum": 32767, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasImageAttachments" }, "task": true }, { "name": "patchExtrasImageAttachments", "summary": "extras_image-attachments_bulk_partial_update", "description": "extras_image-attachments_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"parent\": \"object\", \"name\": \"string\", \"image\": \"string\", \"image_height\": 123, \"image_width\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "image_height", "image_width" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "parent": { "title": "Parent", "type": "object", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 50 }, "image": { "title": "Image", "type": "string", "readOnly": true }, "image_height": { "title": "Image height", "type": "integer", "maximum": 32767, "minimum": 0 }, "image_width": { "title": "Image width", "type": "integer", "maximum": 32767, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasImageAttachments" }, "task": true }, { "name": "deleteExtrasImageAttachments", "summary": "extras_image-attachments_bulk_delete", "description": "extras_image-attachments_bulk_delete", "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": "/deleteExtrasImageAttachments" }, "task": true }, { "name": "getExtrasImageAttachmentsId", "summary": "extras_image-attachments_read", "description": "extras_image-attachments_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this image attachment.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasImageAttachmentsId" }, "task": true }, { "name": "putExtrasImageAttachmentsId", "summary": "extras_image-attachments_update", "description": "extras_image-attachments_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this image attachment.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"parent\": \"object\", \"name\": \"string\", \"image\": \"string\", \"image_height\": 123, \"image_width\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "image_height", "image_width" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "parent": { "title": "Parent", "type": "object", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 50 }, "image": { "title": "Image", "type": "string", "readOnly": true }, "image_height": { "title": "Image height", "type": "integer", "maximum": 32767, "minimum": 0 }, "image_width": { "title": "Image width", "type": "integer", "maximum": 32767, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasImageAttachmentsId" }, "task": true }, { "name": "patchExtrasImageAttachmentsId", "summary": "extras_image-attachments_partial_update", "description": "extras_image-attachments_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this image attachment.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"parent\": \"object\", \"name\": \"string\", \"image\": \"string\", \"image_height\": 123, \"image_width\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "image_height", "image_width" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "parent": { "title": "Parent", "type": "object", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 50 }, "image": { "title": "Image", "type": "string", "readOnly": true }, "image_height": { "title": "Image height", "type": "integer", "maximum": 32767, "minimum": 0 }, "image_width": { "title": "Image width", "type": "integer", "maximum": 32767, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasImageAttachmentsId" }, "task": true }, { "name": "deleteExtrasImageAttachmentsId", "summary": "extras_image-attachments_delete", "description": "extras_image-attachments_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this image attachment.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasImageAttachmentsId" }, "task": true }, { "name": "getExtrasJobResults", "summary": "Retrieve a list of job results", "description": "Retrieve a list of job results", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "completed", "type": "string", "info": ": string", "required": false, "schema": { "title": "completed", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "user", "type": "string", "info": ": string", "required": false, "schema": { "title": "user", "type": "string" } }, { "name": "objType", "type": "string", "info": ": string", "required": false, "schema": { "title": "objType", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "userN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userN", "type": "string" } }, { "name": "objTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "objTypeN", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "job_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true }, "completed": { "title": "Completed", "type": "string", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 255, "minLength": 1 }, "obj_type": { "title": "Obj type", "type": "string", "readOnly": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Pending", "Running", "Completed", "Errored", "Failed" ] }, "value": { "type": "string", "enum": [ "pending", "running", "completed", "errored", "failed" ] } }, "readOnly": true }, "user": { "required": [ "username" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 } } }, "data": { "title": "Data", "type": "object", "x-nullable": true }, "job_id": { "title": "Job id", "type": "string" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasJobResults" }, "task": true }, { "name": "getExtrasJobResultsId", "summary": "Retrieve a list of job results", "description": "Retrieve a list of job results", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this job result.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasJobResultsId" }, "task": true }, { "name": "getExtrasJournalEntries", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "assignedObjectTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectTypeId", "type": "string" } }, { "name": "assignedObjectId", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "kind", "type": "string", "info": ": string", "required": false, "schema": { "title": "kind", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "assignedObjectType", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectType", "type": "string" } }, { "name": "createdById", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdById", "type": "string" } }, { "name": "createdBy", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdBy", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "assignedObjectTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectTypeIdN", "type": "string" } }, { "name": "assignedObjectIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectIdN", "type": "string" } }, { "name": "assignedObjectIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectIdLte", "type": "string" } }, { "name": "assignedObjectIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectIdLt", "type": "string" } }, { "name": "assignedObjectIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectIdGte", "type": "string" } }, { "name": "assignedObjectIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectIdGt", "type": "string" } }, { "name": "kindN", "type": "string", "info": ": string", "required": false, "schema": { "title": "kindN", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "assignedObjectTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectTypeN", "type": "string" } }, { "name": "createdByIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdByIdN", "type": "string" } }, { "name": "createdByN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdByN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "assigned_object_type", "assigned_object_id", "comments" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "created_by": { "title": "Created by", "type": "integer", "x-nullable": true }, "kind": { "title": "Kind", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Info", "Success", "Warning", "Danger" ] }, "value": { "type": "string", "enum": [ "info", "success", "warning", "danger" ] } } }, "comments": { "title": "Comments", "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasJournalEntries" }, "task": true }, { "name": "postExtrasJournalEntries", "summary": "extras_journal-entries_create", "description": "extras_journal-entries_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"created\": \"string\", \"created_by\": 123, \"kind\": \"Must be one of [info, success, warning, danger]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "assigned_object_type", "assigned_object_id", "comments" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "created_by": { "title": "Created by", "type": "integer", "x-nullable": true }, "kind": { "title": "Kind", "type": "string", "enum": [ "info", "success", "warning", "danger" ] }, "comments": { "title": "Comments", "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasJournalEntries" }, "task": true }, { "name": "putExtrasJournalEntries", "summary": "extras_journal-entries_bulk_update", "description": "extras_journal-entries_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"created\": \"string\", \"created_by\": 123, \"kind\": \"Must be one of [info, success, warning, danger]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "assigned_object_type", "assigned_object_id", "comments" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "created_by": { "title": "Created by", "type": "integer", "x-nullable": true }, "kind": { "title": "Kind", "type": "string", "enum": [ "info", "success", "warning", "danger" ] }, "comments": { "title": "Comments", "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasJournalEntries" }, "task": true }, { "name": "patchExtrasJournalEntries", "summary": "extras_journal-entries_bulk_partial_update", "description": "extras_journal-entries_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"created\": \"string\", \"created_by\": 123, \"kind\": \"Must be one of [info, success, warning, danger]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "assigned_object_type", "assigned_object_id", "comments" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "created_by": { "title": "Created by", "type": "integer", "x-nullable": true }, "kind": { "title": "Kind", "type": "string", "enum": [ "info", "success", "warning", "danger" ] }, "comments": { "title": "Comments", "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasJournalEntries" }, "task": true }, { "name": "deleteExtrasJournalEntries", "summary": "extras_journal-entries_bulk_delete", "description": "extras_journal-entries_bulk_delete", "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": "/deleteExtrasJournalEntries" }, "task": true }, { "name": "getExtrasJournalEntriesId", "summary": "extras_journal-entries_read", "description": "extras_journal-entries_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this journal entry.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasJournalEntriesId" }, "task": true }, { "name": "putExtrasJournalEntriesId", "summary": "extras_journal-entries_update", "description": "extras_journal-entries_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this journal entry.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"created\": \"string\", \"created_by\": 123, \"kind\": \"Must be one of [info, success, warning, danger]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "assigned_object_type", "assigned_object_id", "comments" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "created_by": { "title": "Created by", "type": "integer", "x-nullable": true }, "kind": { "title": "Kind", "type": "string", "enum": [ "info", "success", "warning", "danger" ] }, "comments": { "title": "Comments", "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasJournalEntriesId" }, "task": true }, { "name": "patchExtrasJournalEntriesId", "summary": "extras_journal-entries_partial_update", "description": "extras_journal-entries_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this journal entry.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"created\": \"string\", \"created_by\": 123, \"kind\": \"Must be one of [info, success, warning, danger]\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "assigned_object_type", "assigned_object_id", "comments" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "created_by": { "title": "Created by", "type": "integer", "x-nullable": true }, "kind": { "title": "Kind", "type": "string", "enum": [ "info", "success", "warning", "danger" ] }, "comments": { "title": "Comments", "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasJournalEntriesId" }, "task": true }, { "name": "deleteExtrasJournalEntriesId", "summary": "extras_journal-entries_delete", "description": "extras_journal-entries_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this journal entry.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasJournalEntriesId" }, "task": true }, { "name": "getExtrasObjectChanges", "summary": "Retrieve a list of recent changes.", "description": "Retrieve a list of recent changes.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "user", "type": "string", "info": ": string", "required": false, "schema": { "title": "user", "type": "string" } }, { "name": "userName", "type": "string", "info": ": string", "required": false, "schema": { "title": "userName", "type": "string" } }, { "name": "requestId", "type": "string", "info": ": string", "required": false, "schema": { "title": "requestId", "type": "string" } }, { "name": "action", "type": "string", "info": ": string", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "changedObjectTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectTypeId", "type": "string" } }, { "name": "changedObjectId", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectId", "type": "string" } }, { "name": "objectRepr", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectRepr", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "time", "type": "string", "info": ": string", "required": false, "schema": { "title": "time", "type": "string" } }, { "name": "changedObjectType", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectType", "type": "string" } }, { "name": "userId", "type": "string", "info": ": string", "required": false, "schema": { "title": "userId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "userN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userN", "type": "string" } }, { "name": "userNameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameN", "type": "string" } }, { "name": "userNameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameIc", "type": "string" } }, { "name": "userNameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameNic", "type": "string" } }, { "name": "userNameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameIew", "type": "string" } }, { "name": "userNameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameNiew", "type": "string" } }, { "name": "userNameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameIsw", "type": "string" } }, { "name": "userNameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameNisw", "type": "string" } }, { "name": "userNameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameIe", "type": "string" } }, { "name": "userNameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "userNameNie", "type": "string" } }, { "name": "actionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "actionN", "type": "string" } }, { "name": "changedObjectTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectTypeIdN", "type": "string" } }, { "name": "changedObjectIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectIdN", "type": "string" } }, { "name": "changedObjectIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectIdLte", "type": "string" } }, { "name": "changedObjectIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectIdLt", "type": "string" } }, { "name": "changedObjectIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectIdGte", "type": "string" } }, { "name": "changedObjectIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectIdGt", "type": "string" } }, { "name": "objectReprN", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprN", "type": "string" } }, { "name": "objectReprIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprIc", "type": "string" } }, { "name": "objectReprNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprNic", "type": "string" } }, { "name": "objectReprIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprIew", "type": "string" } }, { "name": "objectReprNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprNiew", "type": "string" } }, { "name": "objectReprIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprIsw", "type": "string" } }, { "name": "objectReprNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprNisw", "type": "string" } }, { "name": "objectReprIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprIe", "type": "string" } }, { "name": "objectReprNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectReprNie", "type": "string" } }, { "name": "changedObjectTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "changedObjectTypeN", "type": "string" } }, { "name": "userIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userIdN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "changed_object_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "time": { "title": "Time", "type": "string", "readOnly": true }, "user": { "required": [ "username" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 } } }, "user_name": { "title": "User name", "type": "string", "readOnly": true, "minLength": 1 }, "request_id": { "title": "Request id", "type": "string", "readOnly": true }, "action": { "title": "Action", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Created", "Updated", "Deleted" ] }, "value": { "type": "string", "enum": [ "create", "update", "delete" ] } }, "readOnly": true }, "changed_object_type": { "title": "Changed object type", "type": "string", "readOnly": true }, "changed_object_id": { "title": "Changed object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "changed_object": { "title": "Changed object", "description": "\nSerialize a nested representation of the changed object.\n", "type": "object", "readOnly": true }, "prechange_data": { "title": "Prechange data", "type": "object", "readOnly": true, "x-nullable": true }, "postchange_data": { "title": "Postchange data", "type": "object", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasObjectChanges" }, "task": true }, { "name": "getExtrasObjectChangesId", "summary": "Retrieve a list of recent changes.", "description": "Retrieve a list of recent changes.", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this object change.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasObjectChangesId" }, "task": true }, { "name": "getExtrasReports", "summary": "Compile all reports and their related results (if any). Result data is deferred in the list view.", "description": "Compile all reports and their related results (if any). Result data is deferred in the list view.", "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": "/getExtrasReports" }, "task": true }, { "name": "getExtrasReportsId", "summary": "Retrieve a single Report identified as \" . \".", "description": "Retrieve a single Report identified as \" . \".", "input": [ { "name": "id", "type": "string", "info": ": string", "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": "/getExtrasReportsId" }, "task": true }, { "name": "postExtrasReportsIdRun", "summary": "Run a Report identified as \" . \" and return the pending JobResult as the result", "description": "Run a Report identified as \" . \" and return the pending JobResult as the result", "input": [ { "name": "id", "type": "string", "info": ": string", "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": "/postExtrasReportsIdRun" }, "task": true }, { "name": "getExtrasScripts", "summary": "extras_scripts_list", "description": "extras_scripts_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": "/getExtrasScripts" }, "task": true }, { "name": "getExtrasScriptsId", "summary": "extras_scripts_read", "description": "extras_scripts_read", "input": [ { "name": "id", "type": "string", "info": ": string", "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": "/getExtrasScriptsId" }, "task": true }, { "name": "getExtrasTags", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "color", "type": "string", "info": ": string", "required": false, "schema": { "title": "color", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "contentType", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentType", "type": "string" } }, { "name": "contentTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "colorN", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorN", "type": "string" } }, { "name": "colorIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIc", "type": "string" } }, { "name": "colorNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNic", "type": "string" } }, { "name": "colorIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIew", "type": "string" } }, { "name": "colorNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNiew", "type": "string" } }, { "name": "colorIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIsw", "type": "string" } }, { "name": "colorNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNisw", "type": "string" } }, { "name": "colorIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorIe", "type": "string" } }, { "name": "colorNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "colorNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tagged_items": { "title": "Tagged items", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasTags" }, "task": true }, { "name": "postExtrasTags", "summary": "extras_tags_create", "description": "extras_tags_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tagged_items\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tagged_items": { "title": "Tagged items", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasTags" }, "task": true }, { "name": "putExtrasTags", "summary": "extras_tags_bulk_update", "description": "extras_tags_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tagged_items\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tagged_items": { "title": "Tagged items", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasTags" }, "task": true }, { "name": "patchExtrasTags", "summary": "extras_tags_bulk_partial_update", "description": "extras_tags_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tagged_items\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tagged_items": { "title": "Tagged items", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasTags" }, "task": true }, { "name": "deleteExtrasTags", "summary": "extras_tags_bulk_delete", "description": "extras_tags_bulk_delete", "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": "/deleteExtrasTags" }, "task": true }, { "name": "getExtrasTagsId", "summary": "extras_tags_read", "description": "extras_tags_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tag.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasTagsId" }, "task": true }, { "name": "putExtrasTagsId", "summary": "extras_tags_update", "description": "extras_tags_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tag.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tagged_items\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tagged_items": { "title": "Tagged items", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasTagsId" }, "task": true }, { "name": "patchExtrasTagsId", "summary": "extras_tags_partial_update", "description": "extras_tags_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tag.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\", \"description\": \"string\", \"tagged_items\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tagged_items": { "title": "Tagged items", "type": "integer", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasTagsId" }, "task": true }, { "name": "deleteExtrasTagsId", "summary": "extras_tags_delete", "description": "extras_tags_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tag.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasTagsId" }, "task": true }, { "name": "getExtrasWebhooks", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "typeCreate", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeCreate", "type": "string" } }, { "name": "typeUpdate", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeUpdate", "type": "string" } }, { "name": "typeDelete", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeDelete", "type": "string" } }, { "name": "payloadUrl", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrl", "type": "string" } }, { "name": "enabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "enabled", "type": "string" } }, { "name": "httpMethod", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpMethod", "type": "string" } }, { "name": "httpContentType", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentType", "type": "string" } }, { "name": "secret", "type": "string", "info": ": string", "required": false, "schema": { "title": "secret", "type": "string" } }, { "name": "sslVerification", "type": "string", "info": ": string", "required": false, "schema": { "title": "sslVerification", "type": "string" } }, { "name": "caFilePath", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePath", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "contentTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeId", "type": "string" } }, { "name": "contentTypes", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypes", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "payloadUrlN", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlN", "type": "string" } }, { "name": "payloadUrlIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlIc", "type": "string" } }, { "name": "payloadUrlNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlNic", "type": "string" } }, { "name": "payloadUrlIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlIew", "type": "string" } }, { "name": "payloadUrlNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlNiew", "type": "string" } }, { "name": "payloadUrlIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlIsw", "type": "string" } }, { "name": "payloadUrlNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlNisw", "type": "string" } }, { "name": "payloadUrlIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlIe", "type": "string" } }, { "name": "payloadUrlNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "payloadUrlNie", "type": "string" } }, { "name": "httpMethodN", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpMethodN", "type": "string" } }, { "name": "httpContentTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeN", "type": "string" } }, { "name": "httpContentTypeIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeIc", "type": "string" } }, { "name": "httpContentTypeNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeNic", "type": "string" } }, { "name": "httpContentTypeIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeIew", "type": "string" } }, { "name": "httpContentTypeNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeNiew", "type": "string" } }, { "name": "httpContentTypeIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeIsw", "type": "string" } }, { "name": "httpContentTypeNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeNisw", "type": "string" } }, { "name": "httpContentTypeIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeIe", "type": "string" } }, { "name": "httpContentTypeNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "httpContentTypeNie", "type": "string" } }, { "name": "secretN", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretN", "type": "string" } }, { "name": "secretIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretIc", "type": "string" } }, { "name": "secretNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretNic", "type": "string" } }, { "name": "secretIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretIew", "type": "string" } }, { "name": "secretNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretNiew", "type": "string" } }, { "name": "secretIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretIsw", "type": "string" } }, { "name": "secretNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretNisw", "type": "string" } }, { "name": "secretIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretIe", "type": "string" } }, { "name": "secretNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "secretNie", "type": "string" } }, { "name": "caFilePathN", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathN", "type": "string" } }, { "name": "caFilePathIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathIc", "type": "string" } }, { "name": "caFilePathNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathNic", "type": "string" } }, { "name": "caFilePathIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathIew", "type": "string" } }, { "name": "caFilePathNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathNiew", "type": "string" } }, { "name": "caFilePathIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathIsw", "type": "string" } }, { "name": "caFilePathNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathNisw", "type": "string" } }, { "name": "caFilePathIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathIe", "type": "string" } }, { "name": "caFilePathNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "caFilePathNie", "type": "string" } }, { "name": "contentTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdN", "type": "string" } }, { "name": "contentTypeIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdLte", "type": "string" } }, { "name": "contentTypeIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdLt", "type": "string" } }, { "name": "contentTypeIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdGte", "type": "string" } }, { "name": "contentTypeIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdGt", "type": "string" } }, { "name": "contentTypesN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesN", "type": "string" } }, { "name": "contentTypesIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIc", "type": "string" } }, { "name": "contentTypesNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNic", "type": "string" } }, { "name": "contentTypesIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIew", "type": "string" } }, { "name": "contentTypesNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNiew", "type": "string" } }, { "name": "contentTypesIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIsw", "type": "string" } }, { "name": "contentTypesNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNisw", "type": "string" } }, { "name": "contentTypesIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIe", "type": "string" } }, { "name": "contentTypesNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNie", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "content_types", "name", "payload_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "type_create": { "title": "Type create", "description": "Call this webhook when a matching object is created.", "type": "boolean", "default": false }, "type_update": { "title": "Type update", "description": "Call this webhook when a matching object is updated.", "type": "boolean", "default": false }, "type_delete": { "title": "Type delete", "description": "Call this webhook when a matching object is deleted.", "type": "boolean", "default": false }, "payload_url": { "title": "URL", "description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.", "type": "string", "maxLength": 500, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "http_method": { "title": "HTTP method", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "http_content_type": { "title": "HTTP content type", "description": "The complete list of official content types is available here.", "type": "string", "maxLength": 100, "minLength": 1 }, "additional_headers": { "title": "Additional headers", "description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).", "type": "string" }, "body_template": { "title": "Body template", "description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.", "type": "string" }, "secret": { "title": "Secret", "description": "When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.", "type": "string", "maxLength": 255 }, "conditions": { "title": "Conditions", "description": "A set of conditions which determine whether the webhook will be generated.", "type": "object", "x-nullable": true }, "ssl_verification": { "title": "SSL verification", "description": "Enable SSL certificate verification. Disable with caution!", "type": "boolean" }, "ca_file_path": { "title": "CA File Path", "description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.", "type": "string", "maxLength": 4096, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasWebhooks" }, "task": true }, { "name": "postExtrasWebhooks", "summary": "extras_webhooks_create", "description": "extras_webhooks_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"type_create\": \"boolean\", \"type_update\": \"boolean\", \"type_delete\": \"boolean\", \"payload_url\": \"string\", \"enabled\": \"boolean\", \"http_method\": \"Must be one of [GET, POST, PUT, PATCH, DELETE]\", \"http_content_type\": \"string\", \"additional_headers\": \"string\", \"body_template\": \"string\", \"secret\": \"string\", \"conditions\": \"object\", \"ssl_verification\": \"boolean\", \"ca_file_path\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "payload_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "type_create": { "title": "Type create", "description": "Call this webhook when a matching object is created.", "type": "boolean", "default": false }, "type_update": { "title": "Type update", "description": "Call this webhook when a matching object is updated.", "type": "boolean", "default": false }, "type_delete": { "title": "Type delete", "description": "Call this webhook when a matching object is deleted.", "type": "boolean", "default": false }, "payload_url": { "title": "URL", "description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.", "type": "string", "maxLength": 500, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "http_method": { "title": "HTTP method", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "http_content_type": { "title": "HTTP content type", "description": "The complete list of official content types is available here.", "type": "string", "maxLength": 100, "minLength": 1 }, "additional_headers": { "title": "Additional headers", "description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).", "type": "string" }, "body_template": { "title": "Body template", "description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.", "type": "string" }, "secret": { "title": "Secret", "description": "When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.", "type": "string", "maxLength": 255 }, "conditions": { "title": "Conditions", "description": "A set of conditions which determine whether the webhook will be generated.", "type": "object", "x-nullable": true }, "ssl_verification": { "title": "SSL verification", "description": "Enable SSL certificate verification. Disable with caution!", "type": "boolean" }, "ca_file_path": { "title": "CA File Path", "description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.", "type": "string", "maxLength": 4096, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasWebhooks" }, "task": true }, { "name": "putExtrasWebhooks", "summary": "extras_webhooks_bulk_update", "description": "extras_webhooks_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"type_create\": \"boolean\", \"type_update\": \"boolean\", \"type_delete\": \"boolean\", \"payload_url\": \"string\", \"enabled\": \"boolean\", \"http_method\": \"Must be one of [GET, POST, PUT, PATCH, DELETE]\", \"http_content_type\": \"string\", \"additional_headers\": \"string\", \"body_template\": \"string\", \"secret\": \"string\", \"conditions\": \"object\", \"ssl_verification\": \"boolean\", \"ca_file_path\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "payload_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "type_create": { "title": "Type create", "description": "Call this webhook when a matching object is created.", "type": "boolean", "default": false }, "type_update": { "title": "Type update", "description": "Call this webhook when a matching object is updated.", "type": "boolean", "default": false }, "type_delete": { "title": "Type delete", "description": "Call this webhook when a matching object is deleted.", "type": "boolean", "default": false }, "payload_url": { "title": "URL", "description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.", "type": "string", "maxLength": 500, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "http_method": { "title": "HTTP method", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "http_content_type": { "title": "HTTP content type", "description": "The complete list of official content types is available here.", "type": "string", "maxLength": 100, "minLength": 1 }, "additional_headers": { "title": "Additional headers", "description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).", "type": "string" }, "body_template": { "title": "Body template", "description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.", "type": "string" }, "secret": { "title": "Secret", "description": "When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.", "type": "string", "maxLength": 255 }, "conditions": { "title": "Conditions", "description": "A set of conditions which determine whether the webhook will be generated.", "type": "object", "x-nullable": true }, "ssl_verification": { "title": "SSL verification", "description": "Enable SSL certificate verification. Disable with caution!", "type": "boolean" }, "ca_file_path": { "title": "CA File Path", "description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.", "type": "string", "maxLength": 4096, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasWebhooks" }, "task": true }, { "name": "patchExtrasWebhooks", "summary": "extras_webhooks_bulk_partial_update", "description": "extras_webhooks_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"type_create\": \"boolean\", \"type_update\": \"boolean\", \"type_delete\": \"boolean\", \"payload_url\": \"string\", \"enabled\": \"boolean\", \"http_method\": \"Must be one of [GET, POST, PUT, PATCH, DELETE]\", \"http_content_type\": \"string\", \"additional_headers\": \"string\", \"body_template\": \"string\", \"secret\": \"string\", \"conditions\": \"object\", \"ssl_verification\": \"boolean\", \"ca_file_path\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "payload_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "type_create": { "title": "Type create", "description": "Call this webhook when a matching object is created.", "type": "boolean", "default": false }, "type_update": { "title": "Type update", "description": "Call this webhook when a matching object is updated.", "type": "boolean", "default": false }, "type_delete": { "title": "Type delete", "description": "Call this webhook when a matching object is deleted.", "type": "boolean", "default": false }, "payload_url": { "title": "URL", "description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.", "type": "string", "maxLength": 500, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "http_method": { "title": "HTTP method", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "http_content_type": { "title": "HTTP content type", "description": "The complete list of official content types is available here.", "type": "string", "maxLength": 100, "minLength": 1 }, "additional_headers": { "title": "Additional headers", "description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).", "type": "string" }, "body_template": { "title": "Body template", "description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.", "type": "string" }, "secret": { "title": "Secret", "description": "When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.", "type": "string", "maxLength": 255 }, "conditions": { "title": "Conditions", "description": "A set of conditions which determine whether the webhook will be generated.", "type": "object", "x-nullable": true }, "ssl_verification": { "title": "SSL verification", "description": "Enable SSL certificate verification. Disable with caution!", "type": "boolean" }, "ca_file_path": { "title": "CA File Path", "description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.", "type": "string", "maxLength": 4096, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasWebhooks" }, "task": true }, { "name": "deleteExtrasWebhooks", "summary": "extras_webhooks_bulk_delete", "description": "extras_webhooks_bulk_delete", "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": "/deleteExtrasWebhooks" }, "task": true }, { "name": "getExtrasWebhooksId", "summary": "extras_webhooks_read", "description": "extras_webhooks_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this webhook.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasWebhooksId" }, "task": true }, { "name": "putExtrasWebhooksId", "summary": "extras_webhooks_update", "description": "extras_webhooks_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this webhook.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"type_create\": \"boolean\", \"type_update\": \"boolean\", \"type_delete\": \"boolean\", \"payload_url\": \"string\", \"enabled\": \"boolean\", \"http_method\": \"Must be one of [GET, POST, PUT, PATCH, DELETE]\", \"http_content_type\": \"string\", \"additional_headers\": \"string\", \"body_template\": \"string\", \"secret\": \"string\", \"conditions\": \"object\", \"ssl_verification\": \"boolean\", \"ca_file_path\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "payload_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "type_create": { "title": "Type create", "description": "Call this webhook when a matching object is created.", "type": "boolean", "default": false }, "type_update": { "title": "Type update", "description": "Call this webhook when a matching object is updated.", "type": "boolean", "default": false }, "type_delete": { "title": "Type delete", "description": "Call this webhook when a matching object is deleted.", "type": "boolean", "default": false }, "payload_url": { "title": "URL", "description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.", "type": "string", "maxLength": 500, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "http_method": { "title": "HTTP method", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "http_content_type": { "title": "HTTP content type", "description": "The complete list of official content types is available here.", "type": "string", "maxLength": 100, "minLength": 1 }, "additional_headers": { "title": "Additional headers", "description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).", "type": "string" }, "body_template": { "title": "Body template", "description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.", "type": "string" }, "secret": { "title": "Secret", "description": "When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.", "type": "string", "maxLength": 255 }, "conditions": { "title": "Conditions", "description": "A set of conditions which determine whether the webhook will be generated.", "type": "object", "x-nullable": true }, "ssl_verification": { "title": "SSL verification", "description": "Enable SSL certificate verification. Disable with caution!", "type": "boolean" }, "ca_file_path": { "title": "CA File Path", "description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.", "type": "string", "maxLength": 4096, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasWebhooksId" }, "task": true }, { "name": "patchExtrasWebhooksId", "summary": "extras_webhooks_partial_update", "description": "extras_webhooks_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this webhook.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"type_create\": \"boolean\", \"type_update\": \"boolean\", \"type_delete\": \"boolean\", \"payload_url\": \"string\", \"enabled\": \"boolean\", \"http_method\": \"Must be one of [GET, POST, PUT, PATCH, DELETE]\", \"http_content_type\": \"string\", \"additional_headers\": \"string\", \"body_template\": \"string\", \"secret\": \"string\", \"conditions\": \"object\", \"ssl_verification\": \"boolean\", \"ca_file_path\": \"string\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "payload_url" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "type_create": { "title": "Type create", "description": "Call this webhook when a matching object is created.", "type": "boolean", "default": false }, "type_update": { "title": "Type update", "description": "Call this webhook when a matching object is updated.", "type": "boolean", "default": false }, "type_delete": { "title": "Type delete", "description": "Call this webhook when a matching object is deleted.", "type": "boolean", "default": false }, "payload_url": { "title": "URL", "description": "This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.", "type": "string", "maxLength": 500, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "http_method": { "title": "HTTP method", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "http_content_type": { "title": "HTTP content type", "description": "The complete list of official content types is available here.", "type": "string", "maxLength": 100, "minLength": 1 }, "additional_headers": { "title": "Additional headers", "description": "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).", "type": "string" }, "body_template": { "title": "Body template", "description": "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.", "type": "string" }, "secret": { "title": "Secret", "description": "When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.", "type": "string", "maxLength": 255 }, "conditions": { "title": "Conditions", "description": "A set of conditions which determine whether the webhook will be generated.", "type": "object", "x-nullable": true }, "ssl_verification": { "title": "SSL verification", "description": "Enable SSL certificate verification. Disable with caution!", "type": "boolean" }, "ca_file_path": { "title": "CA File Path", "description": "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.", "type": "string", "maxLength": 4096, "x-nullable": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasWebhooksId" }, "task": true }, { "name": "deleteExtrasWebhooksId", "summary": "extras_webhooks_delete", "description": "extras_webhooks_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this webhook.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasWebhooksId" }, "task": true }, { "name": "getIpamAggregates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "dateAdded", "type": "string", "info": ": string", "required": false, "schema": { "title": "dateAdded", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "family", "type": "number", "info": ": 123", "required": false, "schema": { "title": "family", "type": "number" } }, { "name": "prefix", "type": "string", "info": ": string", "required": false, "schema": { "title": "prefix", "type": "string" } }, { "name": "rirId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rirId", "type": "string" } }, { "name": "rir", "type": "string", "info": ": string", "required": false, "schema": { "title": "rir", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "dateAddedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "dateAddedN", "type": "string" } }, { "name": "dateAddedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "dateAddedLte", "type": "string" } }, { "name": "dateAddedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "dateAddedLt", "type": "string" } }, { "name": "dateAddedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "dateAddedGte", "type": "string" } }, { "name": "dateAddedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "dateAddedGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "rirIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rirIdN", "type": "string" } }, { "name": "rirN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rirN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "prefix", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "IPv4", "IPv6" ] }, "value": { "type": "integer", "enum": [ 4, 6 ] } }, "readOnly": true }, "prefix": { "title": "Prefix", "type": "string" }, "rir": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "aggregate_count": { "title": "Aggregate count", "type": "integer", "readOnly": true } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "date_added": { "title": "Date added", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamAggregates" }, "task": true }, { "name": "postIpamAggregates", "summary": "ipam_aggregates_create", "description": "ipam_aggregates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"rir\": 123, \"tenant\": 123, \"date_added\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "prefix", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "type": "string" }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "date_added": { "title": "Date added", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamAggregates" }, "task": true }, { "name": "putIpamAggregates", "summary": "ipam_aggregates_bulk_update", "description": "ipam_aggregates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"rir\": 123, \"tenant\": 123, \"date_added\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "prefix", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "type": "string" }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "date_added": { "title": "Date added", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamAggregates" }, "task": true }, { "name": "patchIpamAggregates", "summary": "ipam_aggregates_bulk_partial_update", "description": "ipam_aggregates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"rir\": 123, \"tenant\": 123, \"date_added\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "prefix", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "type": "string" }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "date_added": { "title": "Date added", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamAggregates" }, "task": true }, { "name": "deleteIpamAggregates", "summary": "ipam_aggregates_bulk_delete", "description": "ipam_aggregates_bulk_delete", "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": "/deleteIpamAggregates" }, "task": true }, { "name": "getIpamAggregatesId", "summary": "ipam_aggregates_read", "description": "ipam_aggregates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this aggregate.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamAggregatesId" }, "task": true }, { "name": "putIpamAggregatesId", "summary": "ipam_aggregates_update", "description": "ipam_aggregates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this aggregate.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"rir\": 123, \"tenant\": 123, \"date_added\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "prefix", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "type": "string" }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "date_added": { "title": "Date added", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamAggregatesId" }, "task": true }, { "name": "patchIpamAggregatesId", "summary": "ipam_aggregates_partial_update", "description": "ipam_aggregates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this aggregate.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"rir\": 123, \"tenant\": 123, \"date_added\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "prefix", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "type": "string" }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "date_added": { "title": "Date added", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamAggregatesId" }, "task": true }, { "name": "deleteIpamAggregatesId", "summary": "ipam_aggregates_delete", "description": "ipam_aggregates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this aggregate.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamAggregatesId" }, "task": true }, { "name": "getIpamAsns", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "asn", "type": "string", "info": ": string", "required": false, "schema": { "title": "asn", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "rirId", "type": "string", "info": ": string", "required": false, "schema": { "title": "rirId", "type": "string" } }, { "name": "rir", "type": "string", "info": ": string", "required": false, "schema": { "title": "rir", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "asnN", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnN", "type": "string" } }, { "name": "asnLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnLte", "type": "string" } }, { "name": "asnLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnLt", "type": "string" } }, { "name": "asnGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnGte", "type": "string" } }, { "name": "asnGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "asnGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "rirIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rirIdN", "type": "string" } }, { "name": "rirN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rirN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "asn", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1 }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "provider_count": { "title": "Provider count", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamAsns" }, "task": true }, { "name": "postIpamAsns", "summary": "ipam_asns_create", "description": "ipam_asns_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"asn\": 123, \"rir\": 123, \"tenant\": 123, \"description\": \"string\", \"site_count\": 123, \"provider_count\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "asn", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1 }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "provider_count": { "title": "Provider count", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamAsns" }, "task": true }, { "name": "putIpamAsns", "summary": "ipam_asns_bulk_update", "description": "ipam_asns_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"asn\": 123, \"rir\": 123, \"tenant\": 123, \"description\": \"string\", \"site_count\": 123, \"provider_count\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "asn", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1 }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "provider_count": { "title": "Provider count", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamAsns" }, "task": true }, { "name": "patchIpamAsns", "summary": "ipam_asns_bulk_partial_update", "description": "ipam_asns_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"asn\": 123, \"rir\": 123, \"tenant\": 123, \"description\": \"string\", \"site_count\": 123, \"provider_count\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "asn", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1 }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "provider_count": { "title": "Provider count", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamAsns" }, "task": true }, { "name": "deleteIpamAsns", "summary": "ipam_asns_bulk_delete", "description": "ipam_asns_bulk_delete", "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": "/deleteIpamAsns" }, "task": true }, { "name": "getIpamAsnsId", "summary": "ipam_asns_read", "description": "ipam_asns_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this ASN.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamAsnsId" }, "task": true }, { "name": "putIpamAsnsId", "summary": "ipam_asns_update", "description": "ipam_asns_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this ASN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"asn\": 123, \"rir\": 123, \"tenant\": 123, \"description\": \"string\", \"site_count\": 123, \"provider_count\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "asn", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1 }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "provider_count": { "title": "Provider count", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamAsnsId" }, "task": true }, { "name": "patchIpamAsnsId", "summary": "ipam_asns_partial_update", "description": "ipam_asns_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this ASN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"asn\": 123, \"rir\": 123, \"tenant\": 123, \"description\": \"string\", \"site_count\": 123, \"provider_count\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "asn", "rir" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "asn": { "title": "ASN", "description": "32-bit autonomous system number", "type": "integer", "maximum": 4294967295, "minimum": 1 }, "rir": { "title": "RIR", "type": "integer" }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "provider_count": { "title": "Provider count", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamAsnsId" }, "task": true }, { "name": "deleteIpamAsnsId", "summary": "ipam_asns_delete", "description": "ipam_asns_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this ASN.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamAsnsId" }, "task": true }, { "name": "getIpamFhrpGroupAssignments", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "interfaceType", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceType", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "priority", "type": "string", "info": ": string", "required": false, "schema": { "title": "priority", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "virtualMachine", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachine", "type": "string" } }, { "name": "virtualMachineId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineId", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "interfaceTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceTypeN", "type": "string" } }, { "name": "interfaceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceIdN", "type": "string" } }, { "name": "interfaceIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceIdLte", "type": "string" } }, { "name": "interfaceIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceIdLt", "type": "string" } }, { "name": "interfaceIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceIdGte", "type": "string" } }, { "name": "interfaceIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceIdGt", "type": "string" } }, { "name": "priorityN", "type": "string", "info": ": string", "required": false, "schema": { "title": "priorityN", "type": "string" } }, { "name": "priorityLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "priorityLte", "type": "string" } }, { "name": "priorityLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "priorityLt", "type": "string" } }, { "name": "priorityGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "priorityGte", "type": "string" } }, { "name": "priorityGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "priorityGt", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "group", "interface_type", "interface_id", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "required": [ "protocol", "group_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "vrrp2", "vrrp3", "carp", "clusterxl", "hsrp", "glbp", "other" ] }, "group_id": { "title": "Group ID", "type": "integer", "maximum": 32767, "minimum": 0 } } }, "interface_type": { "title": "Interface type", "type": "string" }, "interface_id": { "title": "Interface id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "interface": { "title": "Interface", "type": "object", "readOnly": true }, "priority": { "title": "Priority", "type": "integer", "maximum": 255, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamFhrpGroupAssignments" }, "task": true }, { "name": "postIpamFhrpGroupAssignments", "summary": "ipam_fhrp-group-assignments_create", "description": "ipam_fhrp-group-assignments_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"interface_type\": \"string\", \"interface_id\": 123, \"interface\": \"object\", \"priority\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "interface_type", "interface_id", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer" }, "interface_type": { "title": "Interface type", "type": "string" }, "interface_id": { "title": "Interface id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "interface": { "title": "Interface", "type": "object", "readOnly": true }, "priority": { "title": "Priority", "type": "integer", "maximum": 255, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamFhrpGroupAssignments" }, "task": true }, { "name": "putIpamFhrpGroupAssignments", "summary": "ipam_fhrp-group-assignments_bulk_update", "description": "ipam_fhrp-group-assignments_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"interface_type\": \"string\", \"interface_id\": 123, \"interface\": \"object\", \"priority\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "interface_type", "interface_id", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer" }, "interface_type": { "title": "Interface type", "type": "string" }, "interface_id": { "title": "Interface id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "interface": { "title": "Interface", "type": "object", "readOnly": true }, "priority": { "title": "Priority", "type": "integer", "maximum": 255, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamFhrpGroupAssignments" }, "task": true }, { "name": "patchIpamFhrpGroupAssignments", "summary": "ipam_fhrp-group-assignments_bulk_partial_update", "description": "ipam_fhrp-group-assignments_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"interface_type\": \"string\", \"interface_id\": 123, \"interface\": \"object\", \"priority\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "interface_type", "interface_id", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer" }, "interface_type": { "title": "Interface type", "type": "string" }, "interface_id": { "title": "Interface id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "interface": { "title": "Interface", "type": "object", "readOnly": true }, "priority": { "title": "Priority", "type": "integer", "maximum": 255, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamFhrpGroupAssignments" }, "task": true }, { "name": "deleteIpamFhrpGroupAssignments", "summary": "ipam_fhrp-group-assignments_bulk_delete", "description": "ipam_fhrp-group-assignments_bulk_delete", "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": "/deleteIpamFhrpGroupAssignments" }, "task": true }, { "name": "getIpamFhrpGroupAssignmentsId", "summary": "ipam_fhrp-group-assignments_read", "description": "ipam_fhrp-group-assignments_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this FHRP group assignment.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamFhrpGroupAssignmentsId" }, "task": true }, { "name": "putIpamFhrpGroupAssignmentsId", "summary": "ipam_fhrp-group-assignments_update", "description": "ipam_fhrp-group-assignments_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this FHRP group assignment.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"interface_type\": \"string\", \"interface_id\": 123, \"interface\": \"object\", \"priority\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "interface_type", "interface_id", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer" }, "interface_type": { "title": "Interface type", "type": "string" }, "interface_id": { "title": "Interface id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "interface": { "title": "Interface", "type": "object", "readOnly": true }, "priority": { "title": "Priority", "type": "integer", "maximum": 255, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamFhrpGroupAssignmentsId" }, "task": true }, { "name": "patchIpamFhrpGroupAssignmentsId", "summary": "ipam_fhrp-group-assignments_partial_update", "description": "ipam_fhrp-group-assignments_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this FHRP group assignment.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"interface_type\": \"string\", \"interface_id\": 123, \"interface\": \"object\", \"priority\": 123, \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "interface_type", "interface_id", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer" }, "interface_type": { "title": "Interface type", "type": "string" }, "interface_id": { "title": "Interface id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "interface": { "title": "Interface", "type": "object", "readOnly": true }, "priority": { "title": "Priority", "type": "integer", "maximum": 255, "minimum": 0 }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamFhrpGroupAssignmentsId" }, "task": true }, { "name": "deleteIpamFhrpGroupAssignmentsId", "summary": "ipam_fhrp-group-assignments_delete", "description": "ipam_fhrp-group-assignments_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this FHRP group assignment.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamFhrpGroupAssignmentsId" }, "task": true }, { "name": "getIpamFhrpGroups", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "authKey", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKey", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "protocol", "type": "string", "info": ": string", "required": false, "schema": { "title": "protocol", "type": "string" } }, { "name": "authType", "type": "string", "info": ": string", "required": false, "schema": { "title": "authType", "type": "string" } }, { "name": "relatedIp", "type": "string", "info": ": string", "required": false, "schema": { "title": "relatedIp", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdLte", "type": "string" } }, { "name": "groupIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdLt", "type": "string" } }, { "name": "groupIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdGte", "type": "string" } }, { "name": "groupIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdGt", "type": "string" } }, { "name": "authKeyN", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyN", "type": "string" } }, { "name": "authKeyIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyIc", "type": "string" } }, { "name": "authKeyNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyNic", "type": "string" } }, { "name": "authKeyIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyIew", "type": "string" } }, { "name": "authKeyNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyNiew", "type": "string" } }, { "name": "authKeyIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyIsw", "type": "string" } }, { "name": "authKeyNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyNisw", "type": "string" } }, { "name": "authKeyIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyIe", "type": "string" } }, { "name": "authKeyNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "authKeyNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "protocolN", "type": "string", "info": ": string", "required": false, "schema": { "title": "protocolN", "type": "string" } }, { "name": "authTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "authTypeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "protocol", "group_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "vrrp2", "vrrp3", "carp", "clusterxl", "hsrp", "glbp", "other" ] }, "group_id": { "title": "Group ID", "type": "integer", "maximum": 32767, "minimum": 0 }, "auth_type": { "title": "Authentication type", "type": "string", "enum": [ "plaintext", "md5" ] }, "auth_key": { "title": "Authentication key", "type": "string", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "ip_addresses": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamFhrpGroups" }, "task": true }, { "name": "postIpamFhrpGroups", "summary": "ipam_fhrp-groups_create", "description": "ipam_fhrp-groups_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"protocol\": \"Must be one of [vrrp2, vrrp3, carp, clusterxl, hsrp, glbp, other]\", \"group_id\": 123, \"auth_type\": \"Must be one of [plaintext, md5]\", \"auth_key\": \"string\", \"description\": \"string\", \"ip_addresses\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "protocol", "group_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "vrrp2", "vrrp3", "carp", "clusterxl", "hsrp", "glbp", "other" ] }, "group_id": { "title": "Group ID", "type": "integer", "maximum": 32767, "minimum": 0 }, "auth_type": { "title": "Authentication type", "type": "string", "enum": [ "plaintext", "md5" ] }, "auth_key": { "title": "Authentication key", "type": "string", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "ip_addresses": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamFhrpGroups" }, "task": true }, { "name": "putIpamFhrpGroups", "summary": "ipam_fhrp-groups_bulk_update", "description": "ipam_fhrp-groups_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"protocol\": \"Must be one of [vrrp2, vrrp3, carp, clusterxl, hsrp, glbp, other]\", \"group_id\": 123, \"auth_type\": \"Must be one of [plaintext, md5]\", \"auth_key\": \"string\", \"description\": \"string\", \"ip_addresses\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "protocol", "group_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "vrrp2", "vrrp3", "carp", "clusterxl", "hsrp", "glbp", "other" ] }, "group_id": { "title": "Group ID", "type": "integer", "maximum": 32767, "minimum": 0 }, "auth_type": { "title": "Authentication type", "type": "string", "enum": [ "plaintext", "md5" ] }, "auth_key": { "title": "Authentication key", "type": "string", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "ip_addresses": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamFhrpGroups" }, "task": true }, { "name": "patchIpamFhrpGroups", "summary": "ipam_fhrp-groups_bulk_partial_update", "description": "ipam_fhrp-groups_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"protocol\": \"Must be one of [vrrp2, vrrp3, carp, clusterxl, hsrp, glbp, other]\", \"group_id\": 123, \"auth_type\": \"Must be one of [plaintext, md5]\", \"auth_key\": \"string\", \"description\": \"string\", \"ip_addresses\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "protocol", "group_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "vrrp2", "vrrp3", "carp", "clusterxl", "hsrp", "glbp", "other" ] }, "group_id": { "title": "Group ID", "type": "integer", "maximum": 32767, "minimum": 0 }, "auth_type": { "title": "Authentication type", "type": "string", "enum": [ "plaintext", "md5" ] }, "auth_key": { "title": "Authentication key", "type": "string", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "ip_addresses": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamFhrpGroups" }, "task": true }, { "name": "deleteIpamFhrpGroups", "summary": "ipam_fhrp-groups_bulk_delete", "description": "ipam_fhrp-groups_bulk_delete", "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": "/deleteIpamFhrpGroups" }, "task": true }, { "name": "getIpamFhrpGroupsId", "summary": "ipam_fhrp-groups_read", "description": "ipam_fhrp-groups_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this FHRP group.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamFhrpGroupsId" }, "task": true }, { "name": "putIpamFhrpGroupsId", "summary": "ipam_fhrp-groups_update", "description": "ipam_fhrp-groups_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this FHRP group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"protocol\": \"Must be one of [vrrp2, vrrp3, carp, clusterxl, hsrp, glbp, other]\", \"group_id\": 123, \"auth_type\": \"Must be one of [plaintext, md5]\", \"auth_key\": \"string\", \"description\": \"string\", \"ip_addresses\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "protocol", "group_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "vrrp2", "vrrp3", "carp", "clusterxl", "hsrp", "glbp", "other" ] }, "group_id": { "title": "Group ID", "type": "integer", "maximum": 32767, "minimum": 0 }, "auth_type": { "title": "Authentication type", "type": "string", "enum": [ "plaintext", "md5" ] }, "auth_key": { "title": "Authentication key", "type": "string", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "ip_addresses": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamFhrpGroupsId" }, "task": true }, { "name": "patchIpamFhrpGroupsId", "summary": "ipam_fhrp-groups_partial_update", "description": "ipam_fhrp-groups_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this FHRP group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"protocol\": \"Must be one of [vrrp2, vrrp3, carp, clusterxl, hsrp, glbp, other]\", \"group_id\": 123, \"auth_type\": \"Must be one of [plaintext, md5]\", \"auth_key\": \"string\", \"description\": \"string\", \"ip_addresses\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "protocol", "group_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "vrrp2", "vrrp3", "carp", "clusterxl", "hsrp", "glbp", "other" ] }, "group_id": { "title": "Group ID", "type": "integer", "maximum": 32767, "minimum": 0 }, "auth_type": { "title": "Authentication type", "type": "string", "enum": [ "plaintext", "md5" ] }, "auth_key": { "title": "Authentication key", "type": "string", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "ip_addresses": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamFhrpGroupsId" }, "task": true }, { "name": "deleteIpamFhrpGroupsId", "summary": "ipam_fhrp-groups_delete", "description": "ipam_fhrp-groups_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this FHRP group.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamFhrpGroupsId" }, "task": true }, { "name": "getIpamIpAddresses", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "dnsName", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsName", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "family", "type": "number", "info": ": 123", "required": false, "schema": { "title": "family", "type": "number" } }, { "name": "parent", "type": "string", "info": ": string", "required": false, "schema": { "title": "parent", "type": "string" } }, { "name": "address", "type": "string", "info": ": string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "maskLength", "type": "number", "info": ": 123", "required": false, "schema": { "title": "maskLength", "type": "number" } }, { "name": "vrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfId", "type": "string" } }, { "name": "vrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrf", "type": "string" } }, { "name": "presentInVrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "presentInVrfId", "type": "string" } }, { "name": "presentInVrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "presentInVrf", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "virtualMachine", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachine", "type": "string" } }, { "name": "virtualMachineId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineId", "type": "string" } }, { "name": "interfaceParam", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceParam", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "vminterface", "type": "string", "info": ": string", "required": false, "schema": { "title": "vminterface", "type": "string" } }, { "name": "vminterfaceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vminterfaceId", "type": "string" } }, { "name": "fhrpgroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "fhrpgroupId", "type": "string" } }, { "name": "assignedToInterface", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedToInterface", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "dnsNameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameN", "type": "string" } }, { "name": "dnsNameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameIc", "type": "string" } }, { "name": "dnsNameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameNic", "type": "string" } }, { "name": "dnsNameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameIew", "type": "string" } }, { "name": "dnsNameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameNiew", "type": "string" } }, { "name": "dnsNameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameIsw", "type": "string" } }, { "name": "dnsNameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameNisw", "type": "string" } }, { "name": "dnsNameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameIe", "type": "string" } }, { "name": "dnsNameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "dnsNameNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "vrfIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfIdN", "type": "string" } }, { "name": "vrfN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfN", "type": "string" } }, { "name": "interfaceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceN", "type": "string" } }, { "name": "interfaceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceIdN", "type": "string" } }, { "name": "vminterfaceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vminterfaceN", "type": "string" } }, { "name": "vminterfaceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vminterfaceIdN", "type": "string" } }, { "name": "fhrpgroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "fhrpgroupIdN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "IPv4", "IPv6" ] }, "value": { "type": "integer", "enum": [ 4, 6 ] } }, "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Active", "Reserved", "Deprecated", "DHCP", "SLAAC" ] }, "value": { "type": "string", "enum": [ "active", "reserved", "deprecated", "dhcp", "slaac" ] } } }, "role": { "title": "Role", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Loopback", "Secondary", "Anycast", "VIP", "VRRP", "HSRP", "GLBP", "CARP" ] }, "value": { "type": "string", "enum": [ "loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp" ] } } }, "assigned_object_type": { "title": "Assigned object type", "type": "string", "x-nullable": true }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "nat_inside": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "nat_outside": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "dns_name": { "title": "DNS Name", "description": "Hostname or FQDN (not case-sensitive)", "type": "string", "pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamIpAddresses" }, "task": true }, { "name": "postIpamIpAddresses", "summary": "ipam_ip-addresses_create", "description": "ipam_ip-addresses_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"address\": \"string\", \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated, dhcp, slaac]\", \"role\": \"Must be one of [loopback, secondary, anycast, vip, vrrp, hsrp, glbp, carp]\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"nat_inside\": 123, \"nat_outside\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"dns_name\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "The operational status of this IP", "type": "string", "enum": [ "active", "reserved", "deprecated", "dhcp", "slaac" ] }, "role": { "title": "Role", "description": "The functional role of this IP", "type": "string", "enum": [ "loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp" ] }, "assigned_object_type": { "title": "Assigned object type", "type": "string", "x-nullable": true }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "nat_inside": { "title": "NAT (Inside)", "description": "The IP for which this address is the \"outside\" IP", "type": "integer", "x-nullable": true }, "nat_outside": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "dns_name": { "title": "DNS Name", "description": "Hostname or FQDN (not case-sensitive)", "type": "string", "pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamIpAddresses" }, "task": true }, { "name": "putIpamIpAddresses", "summary": "ipam_ip-addresses_bulk_update", "description": "ipam_ip-addresses_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"address\": \"string\", \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated, dhcp, slaac]\", \"role\": \"Must be one of [loopback, secondary, anycast, vip, vrrp, hsrp, glbp, carp]\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"nat_inside\": 123, \"nat_outside\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"dns_name\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "The operational status of this IP", "type": "string", "enum": [ "active", "reserved", "deprecated", "dhcp", "slaac" ] }, "role": { "title": "Role", "description": "The functional role of this IP", "type": "string", "enum": [ "loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp" ] }, "assigned_object_type": { "title": "Assigned object type", "type": "string", "x-nullable": true }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "nat_inside": { "title": "NAT (Inside)", "description": "The IP for which this address is the \"outside\" IP", "type": "integer", "x-nullable": true }, "nat_outside": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "dns_name": { "title": "DNS Name", "description": "Hostname or FQDN (not case-sensitive)", "type": "string", "pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamIpAddresses" }, "task": true }, { "name": "patchIpamIpAddresses", "summary": "ipam_ip-addresses_bulk_partial_update", "description": "ipam_ip-addresses_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"address\": \"string\", \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated, dhcp, slaac]\", \"role\": \"Must be one of [loopback, secondary, anycast, vip, vrrp, hsrp, glbp, carp]\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"nat_inside\": 123, \"nat_outside\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"dns_name\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "The operational status of this IP", "type": "string", "enum": [ "active", "reserved", "deprecated", "dhcp", "slaac" ] }, "role": { "title": "Role", "description": "The functional role of this IP", "type": "string", "enum": [ "loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp" ] }, "assigned_object_type": { "title": "Assigned object type", "type": "string", "x-nullable": true }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "nat_inside": { "title": "NAT (Inside)", "description": "The IP for which this address is the \"outside\" IP", "type": "integer", "x-nullable": true }, "nat_outside": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "dns_name": { "title": "DNS Name", "description": "Hostname or FQDN (not case-sensitive)", "type": "string", "pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamIpAddresses" }, "task": true }, { "name": "deleteIpamIpAddresses", "summary": "ipam_ip-addresses_bulk_delete", "description": "ipam_ip-addresses_bulk_delete", "input": [ { "name": "data", "type": "array", "info": "List of IP Objects", "required": true, "schema": { "required": [ ], "type": "object" } } ], "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": "/deleteIpamIpAddresses" }, "task": true }, { "name": "getIpamIpAddressesId", "summary": "ipam_ip-addresses_read", "description": "ipam_ip-addresses_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP address.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamIpAddressesId" }, "task": true }, { "name": "putIpamIpAddressesId", "summary": "ipam_ip-addresses_update", "description": "ipam_ip-addresses_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP address.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"address\": \"string\", \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated, dhcp, slaac]\", \"role\": \"Must be one of [loopback, secondary, anycast, vip, vrrp, hsrp, glbp, carp]\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"nat_inside\": 123, \"nat_outside\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"dns_name\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "The operational status of this IP", "type": "string", "enum": [ "active", "reserved", "deprecated", "dhcp", "slaac" ] }, "role": { "title": "Role", "description": "The functional role of this IP", "type": "string", "enum": [ "loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp" ] }, "assigned_object_type": { "title": "Assigned object type", "type": "string", "x-nullable": true }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "nat_inside": { "title": "NAT (Inside)", "description": "The IP for which this address is the \"outside\" IP", "type": "integer", "x-nullable": true }, "nat_outside": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "dns_name": { "title": "DNS Name", "description": "Hostname or FQDN (not case-sensitive)", "type": "string", "pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamIpAddressesId" }, "task": true }, { "name": "patchIpamIpAddressesId", "summary": "ipam_ip-addresses_partial_update", "description": "ipam_ip-addresses_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP address.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"address\": \"string\", \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated, dhcp, slaac]\", \"role\": \"Must be one of [loopback, secondary, anycast, vip, vrrp, hsrp, glbp, carp]\", \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"nat_inside\": 123, \"nat_outside\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": 123, \"address\": \"string\"}], \"dns_name\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "The operational status of this IP", "type": "string", "enum": [ "active", "reserved", "deprecated", "dhcp", "slaac" ] }, "role": { "title": "Role", "description": "The functional role of this IP", "type": "string", "enum": [ "loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp" ] }, "assigned_object_type": { "title": "Assigned object type", "type": "string", "x-nullable": true }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "nat_inside": { "title": "NAT (Inside)", "description": "The IP for which this address is the \"outside\" IP", "type": "integer", "x-nullable": true }, "nat_outside": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "dns_name": { "title": "DNS Name", "description": "Hostname or FQDN (not case-sensitive)", "type": "string", "pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamIpAddressesId" }, "task": true }, { "name": "deleteIpamIpAddressesId", "summary": "ipam_ip-addresses_delete", "description": "ipam_ip-addresses_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP address.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamIpAddressesId" }, "task": true }, { "name": "getIpamIpRanges", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "family", "type": "number", "info": ": 123", "required": false, "schema": { "title": "family", "type": "number" } }, { "name": "contains", "type": "string", "info": ": string", "required": false, "schema": { "title": "contains", "type": "string" } }, { "name": "vrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfId", "type": "string" } }, { "name": "vrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrf", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "vrfIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfIdN", "type": "string" } }, { "name": "vrfN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "start_address", "end_address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "IPv4", "IPv6" ] }, "value": { "type": "integer", "enum": [ 4, 6 ] } }, "readOnly": true }, "start_address": { "title": "Start address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "end_address": { "title": "End address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "size": { "title": "Size", "type": "integer", "readOnly": true }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Active", "Reserved", "Deprecated" ] }, "value": { "type": "string", "enum": [ "active", "reserved", "deprecated" ] } } }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamIpRanges" }, "task": true }, { "name": "postIpamIpRanges", "summary": "ipam_ip-ranges_create", "description": "ipam_ip-ranges_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"start_address\": \"string\", \"end_address\": \"string\", \"size\": 123, \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123}", "required": true, "schema": { "required": [ "start_address", "end_address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "start_address": { "title": "Start address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "end_address": { "title": "End address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "size": { "title": "Size", "type": "integer", "readOnly": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this range", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this range", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamIpRanges" }, "task": true }, { "name": "putIpamIpRanges", "summary": "ipam_ip-ranges_bulk_update", "description": "ipam_ip-ranges_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"start_address\": \"string\", \"end_address\": \"string\", \"size\": 123, \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123}", "required": true, "schema": { "required": [ "start_address", "end_address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "start_address": { "title": "Start address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "end_address": { "title": "End address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "size": { "title": "Size", "type": "integer", "readOnly": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this range", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this range", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamIpRanges" }, "task": true }, { "name": "patchIpamIpRanges", "summary": "ipam_ip-ranges_bulk_partial_update", "description": "ipam_ip-ranges_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"start_address\": \"string\", \"end_address\": \"string\", \"size\": 123, \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123}", "required": true, "schema": { "required": [ "start_address", "end_address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "start_address": { "title": "Start address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "end_address": { "title": "End address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "size": { "title": "Size", "type": "integer", "readOnly": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this range", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this range", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamIpRanges" }, "task": true }, { "name": "deleteIpamIpRanges", "summary": "ipam_ip-ranges_bulk_delete", "description": "ipam_ip-ranges_bulk_delete", "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": "/deleteIpamIpRanges" }, "task": true }, { "name": "getIpamIpRangesId", "summary": "ipam_ip-ranges_read", "description": "ipam_ip-ranges_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP range.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamIpRangesId" }, "task": true }, { "name": "putIpamIpRangesId", "summary": "ipam_ip-ranges_update", "description": "ipam_ip-ranges_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP range.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"start_address\": \"string\", \"end_address\": \"string\", \"size\": 123, \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123}", "required": true, "schema": { "required": [ "start_address", "end_address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "start_address": { "title": "Start address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "end_address": { "title": "End address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "size": { "title": "Size", "type": "integer", "readOnly": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this range", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this range", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamIpRangesId" }, "task": true }, { "name": "patchIpamIpRangesId", "summary": "ipam_ip-ranges_partial_update", "description": "ipam_ip-ranges_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP range.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"start_address\": \"string\", \"end_address\": \"string\", \"size\": 123, \"vrf\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123}", "required": true, "schema": { "required": [ "start_address", "end_address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "start_address": { "title": "Start address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "end_address": { "title": "End address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "size": { "title": "Size", "type": "integer", "readOnly": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this range", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this range", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamIpRangesId" }, "task": true }, { "name": "deleteIpamIpRangesId", "summary": "ipam_ip-ranges_delete", "description": "ipam_ip-ranges_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP range.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamIpRangesId" }, "task": true }, { "name": "getIpamIpRangesIdAvailableIps", "summary": "ipam_ip-ranges_available-ips_list", "description": "ipam_ip-ranges_available-ips_list", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP address.: 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "properties": { "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "type": "string", "readOnly": true, "minLength": 1 }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamIpRangesIdAvailableIps" }, "task": true }, { "name": "postIpamIpRangesIdAvailableIps", "summary": "ipam_ip-ranges_available-ips_create", "description": "ipam_ip-ranges_available-ips_create", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP address.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"family\": 123, \"address\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "type": "string", "readOnly": true, "minLength": 1 } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "IPv4", "IPv6" ] }, "value": { "type": "integer", "enum": [ 4, 6 ] } }, "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Active", "Reserved", "Deprecated", "DHCP", "SLAAC" ] }, "value": { "type": "string", "enum": [ "active", "reserved", "deprecated", "dhcp", "slaac" ] } } }, "role": { "title": "Role", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Loopback", "Secondary", "Anycast", "VIP", "VRRP", "HSRP", "GLBP", "CARP" ] }, "value": { "type": "string", "enum": [ "loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp" ] } } }, "assigned_object_type": { "title": "Assigned object type", "type": "string", "x-nullable": true }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "nat_inside": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "nat_outside": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "dns_name": { "title": "DNS Name", "description": "Hostname or FQDN (not case-sensitive)", "type": "string", "pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamIpRangesIdAvailableIps" }, "task": true }, { "name": "getIpamL2vpnTerminations", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "assignedObjectTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectTypeId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "l2vpnId", "type": "string", "info": ": string", "required": false, "schema": { "title": "l2vpnId", "type": "string" } }, { "name": "l2vpn", "type": "string", "info": ": string", "required": false, "schema": { "title": "l2vpn", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "virtualMachine", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachine", "type": "string" } }, { "name": "virtualMachineId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineId", "type": "string" } }, { "name": "interfaceParam", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceParam", "type": "string" } }, { "name": "interfaceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceId", "type": "string" } }, { "name": "vminterface", "type": "string", "info": ": string", "required": false, "schema": { "title": "vminterface", "type": "string" } }, { "name": "vminterfaceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vminterfaceId", "type": "string" } }, { "name": "vlan", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlan", "type": "string" } }, { "name": "vlanVid", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVid", "type": "number" } }, { "name": "vlanId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlanId", "type": "string" } }, { "name": "assignedObjectType", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectType", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "assignedObjectTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectTypeIdN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "l2vpnIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "l2vpnIdN", "type": "string" } }, { "name": "l2vpnN", "type": "string", "info": ": string", "required": false, "schema": { "title": "l2vpnN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "virtualMachineN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineN", "type": "string" } }, { "name": "virtualMachineIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineIdN", "type": "string" } }, { "name": "interfaceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceN", "type": "string" } }, { "name": "interfaceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceIdN", "type": "string" } }, { "name": "vminterfaceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vminterfaceN", "type": "string" } }, { "name": "vminterfaceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vminterfaceIdN", "type": "string" } }, { "name": "vlanN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlanN", "type": "string" } }, { "name": "vlanVidN", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidN", "type": "number" } }, { "name": "vlanVidLte", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidLte", "type": "number" } }, { "name": "vlanVidLt", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidLt", "type": "number" } }, { "name": "vlanVidGte", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidGte", "type": "number" } }, { "name": "vlanVidGt", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidGt", "type": "number" } }, { "name": "vlanIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlanIdN", "type": "string" } }, { "name": "assignedObjectTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "assignedObjectTypeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "l2vpn", "assigned_object_type", "assigned_object_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] } } }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamL2vpnTerminations" }, "task": true }, { "name": "postIpamL2vpnTerminations", "summary": "ipam_l2vpn-terminations_create", "description": "ipam_l2vpn-terminations_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"l2vpn\": 123, \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "l2vpn", "assigned_object_type", "assigned_object_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "title": "L2vpn", "type": "integer" }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamL2vpnTerminations" }, "task": true }, { "name": "putIpamL2vpnTerminations", "summary": "ipam_l2vpn-terminations_bulk_update", "description": "ipam_l2vpn-terminations_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"l2vpn\": 123, \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "l2vpn", "assigned_object_type", "assigned_object_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "title": "L2vpn", "type": "integer" }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamL2vpnTerminations" }, "task": true }, { "name": "patchIpamL2vpnTerminations", "summary": "ipam_l2vpn-terminations_bulk_partial_update", "description": "ipam_l2vpn-terminations_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"l2vpn\": 123, \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "l2vpn", "assigned_object_type", "assigned_object_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "title": "L2vpn", "type": "integer" }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamL2vpnTerminations" }, "task": true }, { "name": "deleteIpamL2vpnTerminations", "summary": "ipam_l2vpn-terminations_bulk_delete", "description": "ipam_l2vpn-terminations_bulk_delete", "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": "/deleteIpamL2vpnTerminations" }, "task": true }, { "name": "getIpamL2vpnTerminationsId", "summary": "ipam_l2vpn-terminations_read", "description": "ipam_l2vpn-terminations_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this L2VPN termination.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamL2vpnTerminationsId" }, "task": true }, { "name": "putIpamL2vpnTerminationsId", "summary": "ipam_l2vpn-terminations_update", "description": "ipam_l2vpn-terminations_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this L2VPN termination.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"l2vpn\": 123, \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "l2vpn", "assigned_object_type", "assigned_object_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "title": "L2vpn", "type": "integer" }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamL2vpnTerminationsId" }, "task": true }, { "name": "patchIpamL2vpnTerminationsId", "summary": "ipam_l2vpn-terminations_partial_update", "description": "ipam_l2vpn-terminations_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this L2VPN termination.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"l2vpn\": 123, \"assigned_object_type\": \"string\", \"assigned_object_id\": 123, \"assigned_object\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "l2vpn", "assigned_object_type", "assigned_object_id" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "title": "L2vpn", "type": "integer" }, "assigned_object_type": { "title": "Assigned object type", "type": "string" }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamL2vpnTerminationsId" }, "task": true }, { "name": "deleteIpamL2vpnTerminationsId", "summary": "ipam_l2vpn-terminations_delete", "description": "ipam_l2vpn-terminations_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this L2VPN termination.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamL2vpnTerminationsId" }, "task": true }, { "name": "getIpamL2vpns", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "identifier", "type": "string", "info": ": string", "required": false, "schema": { "title": "identifier", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "importTargetId", "type": "string", "info": ": string", "required": false, "schema": { "title": "importTargetId", "type": "string" } }, { "name": "importTarget", "type": "string", "info": ": string", "required": false, "schema": { "title": "importTarget", "type": "string" } }, { "name": "exportTargetId", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportTargetId", "type": "string" } }, { "name": "exportTarget", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportTarget", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "identifierN", "type": "string", "info": ": string", "required": false, "schema": { "title": "identifierN", "type": "string" } }, { "name": "identifierLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "identifierLte", "type": "string" } }, { "name": "identifierLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "identifierLt", "type": "string" } }, { "name": "identifierGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "identifierGte", "type": "string" } }, { "name": "identifierGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "identifierGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "importTargetIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "importTargetIdN", "type": "string" } }, { "name": "importTargetN", "type": "string", "info": ": string", "required": false, "schema": { "title": "importTargetN", "type": "string" } }, { "name": "exportTargetIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportTargetIdN", "type": "string" } }, { "name": "exportTargetN", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportTargetN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "VPWS", "VPLS", "VXLAN", "VXLAN-EVPN", "MPLS EVPN", "PBB EVPN", "EPL", "EVPL", "Ethernet Private LAN", "Ethernet Virtual Private LAN", "Ethernet Private Tree", "Ethernet Virtual Private Tree" ] }, "value": { "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] } } }, "import_targets": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 } } }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 } } }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamL2vpns" }, "task": true }, { "name": "postIpamL2vpns", "summary": "ipam_l2vpns_create", "description": "ipam_l2vpns_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"identifier\": 123, \"name\": \"string\", \"slug\": \"string\", \"type\": \"Must be one of [vpws, vpls, vxlan, vxlan-evpn, mpls-evpn, pbb-evpn, epl, evpl, ep-lan, evp-lan, ep-tree, evp-tree]\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"description\": \"string\", \"tenant\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamL2vpns" }, "task": true }, { "name": "putIpamL2vpns", "summary": "ipam_l2vpns_bulk_update", "description": "ipam_l2vpns_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"identifier\": 123, \"name\": \"string\", \"slug\": \"string\", \"type\": \"Must be one of [vpws, vpls, vxlan, vxlan-evpn, mpls-evpn, pbb-evpn, epl, evpl, ep-lan, evp-lan, ep-tree, evp-tree]\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"description\": \"string\", \"tenant\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamL2vpns" }, "task": true }, { "name": "patchIpamL2vpns", "summary": "ipam_l2vpns_bulk_partial_update", "description": "ipam_l2vpns_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"identifier\": 123, \"name\": \"string\", \"slug\": \"string\", \"type\": \"Must be one of [vpws, vpls, vxlan, vxlan-evpn, mpls-evpn, pbb-evpn, epl, evpl, ep-lan, evp-lan, ep-tree, evp-tree]\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"description\": \"string\", \"tenant\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamL2vpns" }, "task": true }, { "name": "deleteIpamL2vpns", "summary": "ipam_l2vpns_bulk_delete", "description": "ipam_l2vpns_bulk_delete", "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": "/deleteIpamL2vpns" }, "task": true }, { "name": "getIpamL2vpnsId", "summary": "ipam_l2vpns_read", "description": "ipam_l2vpns_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this L2VPN.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamL2vpnsId" }, "task": true }, { "name": "putIpamL2vpnsId", "summary": "ipam_l2vpns_update", "description": "ipam_l2vpns_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this L2VPN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"identifier\": 123, \"name\": \"string\", \"slug\": \"string\", \"type\": \"Must be one of [vpws, vpls, vxlan, vxlan-evpn, mpls-evpn, pbb-evpn, epl, evpl, ep-lan, evp-lan, ep-tree, evp-tree]\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"description\": \"string\", \"tenant\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamL2vpnsId" }, "task": true }, { "name": "patchIpamL2vpnsId", "summary": "ipam_l2vpns_partial_update", "description": "ipam_l2vpns_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this L2VPN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"identifier\": 123, \"name\": \"string\", \"slug\": \"string\", \"type\": \"Must be one of [vpws, vpls, vxlan, vxlan-evpn, mpls-evpn, pbb-evpn, epl, evpl, ep-lan, evp-lan, ep-tree, evp-tree]\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"description\": \"string\", \"tenant\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamL2vpnsId" }, "task": true }, { "name": "deleteIpamL2vpnsId", "summary": "ipam_l2vpns_delete", "description": "ipam_l2vpns_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this L2VPN.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamL2vpnsId" }, "task": true }, { "name": "getIpamPrefixes", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "isPool", "type": "string", "info": ": string", "required": false, "schema": { "title": "isPool", "type": "string" } }, { "name": "markUtilized", "type": "string", "info": ": string", "required": false, "schema": { "title": "markUtilized", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "family", "type": "number", "info": ": 123", "required": false, "schema": { "title": "family", "type": "number" } }, { "name": "prefix", "type": "string", "info": ": string", "required": false, "schema": { "title": "prefix", "type": "string" } }, { "name": "within", "type": "string", "info": ": string", "required": false, "schema": { "title": "within", "type": "string" } }, { "name": "withinInclude", "type": "string", "info": ": string", "required": false, "schema": { "title": "withinInclude", "type": "string" } }, { "name": "contains", "type": "string", "info": ": string", "required": false, "schema": { "title": "contains", "type": "string" } }, { "name": "depth", "type": "string", "info": ": string", "required": false, "schema": { "title": "depth", "type": "string" } }, { "name": "children", "type": "string", "info": ": string", "required": false, "schema": { "title": "children", "type": "string" } }, { "name": "maskLength", "type": "string", "info": ": string", "required": false, "schema": { "title": "maskLength", "type": "string" } }, { "name": "maskLengthGte", "type": "number", "info": ": 123", "required": false, "schema": { "title": "maskLengthGte", "type": "number" } }, { "name": "maskLengthLte", "type": "number", "info": ": 123", "required": false, "schema": { "title": "maskLengthLte", "type": "number" } }, { "name": "vrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfId", "type": "string" } }, { "name": "vrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrf", "type": "string" } }, { "name": "presentInVrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "presentInVrfId", "type": "string" } }, { "name": "presentInVrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "presentInVrf", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "vlanId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlanId", "type": "string" } }, { "name": "vlanVid", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVid", "type": "number" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "depthN", "type": "string", "info": ": string", "required": false, "schema": { "title": "depthN", "type": "string" } }, { "name": "depthLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "depthLte", "type": "string" } }, { "name": "depthLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "depthLt", "type": "string" } }, { "name": "depthGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "depthGte", "type": "string" } }, { "name": "depthGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "depthGt", "type": "string" } }, { "name": "childrenN", "type": "string", "info": ": string", "required": false, "schema": { "title": "childrenN", "type": "string" } }, { "name": "childrenLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "childrenLte", "type": "string" } }, { "name": "childrenLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "childrenLt", "type": "string" } }, { "name": "childrenGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "childrenGte", "type": "string" } }, { "name": "childrenGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "childrenGt", "type": "string" } }, { "name": "vrfIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfIdN", "type": "string" } }, { "name": "vrfN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "vlanIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlanIdN", "type": "string" } }, { "name": "vlanVidN", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidN", "type": "number" } }, { "name": "vlanVidLte", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidLte", "type": "number" } }, { "name": "vlanVidLt", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidLt", "type": "number" } }, { "name": "vlanVidGte", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidGte", "type": "number" } }, { "name": "vlanVidGt", "type": "number", "info": ": 123", "required": false, "schema": { "title": "vlanVidGt", "type": "number" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "prefix" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "IPv4", "IPv6" ] }, "value": { "type": "integer", "enum": [ 4, 6 ] } }, "readOnly": true }, "prefix": { "title": "Prefix", "description": "IPv4 or IPv6 network with mask", "type": "string" }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "vlan": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Container", "Active", "Reserved", "Deprecated" ] }, "value": { "type": "string", "enum": [ "container", "active", "reserved", "deprecated" ] } } }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "is_pool": { "title": "Is a pool", "description": "All IP addresses within this prefix are considered usable", "type": "boolean" }, "mark_utilized": { "title": "Mark utilized", "description": "Treat as 100% utilized", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamPrefixes" }, "task": true }, { "name": "postIpamPrefixes", "summary": "ipam_prefixes_create", "description": "ipam_prefixes_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"site\": 123, \"vrf\": 123, \"tenant\": 123, \"vlan\": 123, \"status\": \"Must be one of [container, active, reserved, deprecated]\", \"role\": 123, \"is_pool\": \"boolean\", \"mark_utilized\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "prefix" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "description": "IPv4 or IPv6 network with mask", "type": "string" }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this prefix", "type": "string", "enum": [ "container", "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this prefix", "type": "integer", "x-nullable": true }, "is_pool": { "title": "Is a pool", "description": "All IP addresses within this prefix are considered usable", "type": "boolean" }, "mark_utilized": { "title": "Mark utilized", "description": "Treat as 100% utilized", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamPrefixes" }, "task": true }, { "name": "putIpamPrefixes", "summary": "ipam_prefixes_bulk_update", "description": "ipam_prefixes_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"site\": 123, \"vrf\": 123, \"tenant\": 123, \"vlan\": 123, \"status\": \"Must be one of [container, active, reserved, deprecated]\", \"role\": 123, \"is_pool\": \"boolean\", \"mark_utilized\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "prefix" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "description": "IPv4 or IPv6 network with mask", "type": "string" }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this prefix", "type": "string", "enum": [ "container", "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this prefix", "type": "integer", "x-nullable": true }, "is_pool": { "title": "Is a pool", "description": "All IP addresses within this prefix are considered usable", "type": "boolean" }, "mark_utilized": { "title": "Mark utilized", "description": "Treat as 100% utilized", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamPrefixes" }, "task": true }, { "name": "patchIpamPrefixes", "summary": "ipam_prefixes_bulk_partial_update", "description": "ipam_prefixes_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"site\": 123, \"vrf\": 123, \"tenant\": 123, \"vlan\": 123, \"status\": \"Must be one of [container, active, reserved, deprecated]\", \"role\": 123, \"is_pool\": \"boolean\", \"mark_utilized\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "prefix" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "description": "IPv4 or IPv6 network with mask", "type": "string" }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this prefix", "type": "string", "enum": [ "container", "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this prefix", "type": "integer", "x-nullable": true }, "is_pool": { "title": "Is a pool", "description": "All IP addresses within this prefix are considered usable", "type": "boolean" }, "mark_utilized": { "title": "Mark utilized", "description": "Treat as 100% utilized", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamPrefixes" }, "task": true }, { "name": "deleteIpamPrefixes", "summary": "ipam_prefixes_bulk_delete", "description": "ipam_prefixes_bulk_delete", "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": "/deleteIpamPrefixes" }, "task": true }, { "name": "getIpamPrefixesId", "summary": "ipam_prefixes_read", "description": "ipam_prefixes_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this prefix.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamPrefixesId" }, "task": true }, { "name": "putIpamPrefixesId", "summary": "ipam_prefixes_update", "description": "ipam_prefixes_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this prefix.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"site\": 123, \"vrf\": 123, \"tenant\": 123, \"vlan\": 123, \"status\": \"Must be one of [container, active, reserved, deprecated]\", \"role\": 123, \"is_pool\": \"boolean\", \"mark_utilized\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "prefix" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "description": "IPv4 or IPv6 network with mask", "type": "string" }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this prefix", "type": "string", "enum": [ "container", "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this prefix", "type": "integer", "x-nullable": true }, "is_pool": { "title": "Is a pool", "description": "All IP addresses within this prefix are considered usable", "type": "boolean" }, "mark_utilized": { "title": "Mark utilized", "description": "Treat as 100% utilized", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamPrefixesId" }, "task": true }, { "name": "patchIpamPrefixesId", "summary": "ipam_prefixes_partial_update", "description": "ipam_prefixes_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this prefix.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"family\": \"string\", \"prefix\": \"string\", \"site\": 123, \"vrf\": 123, \"tenant\": 123, \"vlan\": 123, \"status\": \"Must be one of [container, active, reserved, deprecated]\", \"role\": 123, \"is_pool\": \"boolean\", \"mark_utilized\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"children\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "prefix" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "string", "readOnly": true }, "prefix": { "title": "Prefix", "description": "IPv4 or IPv6 network with mask", "type": "string" }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "description": "Operational status of this prefix", "type": "string", "enum": [ "container", "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "description": "The primary function of this prefix", "type": "integer", "x-nullable": true }, "is_pool": { "title": "Is a pool", "description": "All IP addresses within this prefix are considered usable", "type": "boolean" }, "mark_utilized": { "title": "Mark utilized", "description": "Treat as 100% utilized", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamPrefixesId" }, "task": true }, { "name": "deleteIpamPrefixesId", "summary": "ipam_prefixes_delete", "description": "ipam_prefixes_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this prefix.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamPrefixesId" }, "task": true }, { "name": "getIpamPrefixesIdAvailableIps", "summary": "ipam_prefixes_available-ips_list", "description": "ipam_prefixes_available-ips_list", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP address.: 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "properties": { "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "type": "string", "readOnly": true, "minLength": 1 }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamPrefixesIdAvailableIps" }, "task": true }, { "name": "postIpamPrefixesIdAvailableIps", "summary": "ipam_prefixes_available-ips_create", "description": "ipam_prefixes_available-ips_create", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this IP address.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"family\": 123, \"address\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "type": "string", "readOnly": true, "minLength": 1 } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "IPv4", "IPv6" ] }, "value": { "type": "integer", "enum": [ 4, 6 ] } }, "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Active", "Reserved", "Deprecated", "DHCP", "SLAAC" ] }, "value": { "type": "string", "enum": [ "active", "reserved", "deprecated", "dhcp", "slaac" ] } } }, "role": { "title": "Role", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Loopback", "Secondary", "Anycast", "VIP", "VRRP", "HSRP", "GLBP", "CARP" ] }, "value": { "type": "string", "enum": [ "loopback", "secondary", "anycast", "vip", "vrrp", "hsrp", "glbp", "carp" ] } } }, "assigned_object_type": { "title": "Assigned object type", "type": "string", "x-nullable": true }, "assigned_object_id": { "title": "Assigned object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0, "x-nullable": true }, "assigned_object": { "title": "Assigned object", "type": "object", "readOnly": true }, "nat_inside": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "nat_outside": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "readOnly": true }, "dns_name": { "title": "DNS Name", "description": "Hostname or FQDN (not case-sensitive)", "type": "string", "pattern": "^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$", "maxLength": 255 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamPrefixesIdAvailableIps" }, "task": true }, { "name": "getIpamPrefixesIdAvailablePrefixes", "summary": "ipam_prefixes_available-prefixes_list", "description": "ipam_prefixes_available-prefixes_list", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this prefix.: 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "properties": { "family": { "title": "Family", "type": "integer", "readOnly": true }, "prefix": { "title": "Prefix", "type": "string", "readOnly": true, "minLength": 1 }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamPrefixesIdAvailablePrefixes" }, "task": true }, { "name": "postIpamPrefixesIdAvailablePrefixes", "summary": "ipam_prefixes_available-prefixes_create", "description": "ipam_prefixes_available-prefixes_create", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this prefix.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"prefix_length\": 123}", "required": true, "schema": { "required": [ "prefix_length" ], "type": "object", "properties": { "prefix_length": { "title": "Prefix length", "type": "integer" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "required": [ "prefix" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "IPv4", "IPv6" ] }, "value": { "type": "integer", "enum": [ 4, 6 ] } }, "readOnly": true }, "prefix": { "title": "Prefix", "description": "IPv4 or IPv6 network with mask", "type": "string" }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "vlan": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Container", "Active", "Reserved", "Deprecated" ] }, "value": { "type": "string", "enum": [ "container", "active", "reserved", "deprecated" ] } } }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "is_pool": { "title": "Is a pool", "description": "All IP addresses within this prefix are considered usable", "type": "boolean" }, "mark_utilized": { "title": "Mark utilized", "description": "Treat as 100% utilized", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "children": { "title": "Children", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamPrefixesIdAvailablePrefixes" }, "task": true }, { "name": "getIpamRirs", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "isPrivate", "type": "string", "info": ": string", "required": false, "schema": { "title": "isPrivate", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "is_private": { "title": "Private", "description": "IP space managed by this RIR is considered private", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "aggregate_count": { "title": "Aggregate count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamRirs" }, "task": true }, { "name": "postIpamRirs", "summary": "ipam_rirs_create", "description": "ipam_rirs_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"is_private\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"aggregate_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "is_private": { "title": "Private", "description": "IP space managed by this RIR is considered private", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "aggregate_count": { "title": "Aggregate count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamRirs" }, "task": true }, { "name": "putIpamRirs", "summary": "ipam_rirs_bulk_update", "description": "ipam_rirs_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"is_private\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"aggregate_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "is_private": { "title": "Private", "description": "IP space managed by this RIR is considered private", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "aggregate_count": { "title": "Aggregate count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamRirs" }, "task": true }, { "name": "patchIpamRirs", "summary": "ipam_rirs_bulk_partial_update", "description": "ipam_rirs_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"is_private\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"aggregate_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "is_private": { "title": "Private", "description": "IP space managed by this RIR is considered private", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "aggregate_count": { "title": "Aggregate count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamRirs" }, "task": true }, { "name": "deleteIpamRirs", "summary": "ipam_rirs_bulk_delete", "description": "ipam_rirs_bulk_delete", "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": "/deleteIpamRirs" }, "task": true }, { "name": "getIpamRirsId", "summary": "ipam_rirs_read", "description": "ipam_rirs_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this RIR.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamRirsId" }, "task": true }, { "name": "putIpamRirsId", "summary": "ipam_rirs_update", "description": "ipam_rirs_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this RIR.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"is_private\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"aggregate_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "is_private": { "title": "Private", "description": "IP space managed by this RIR is considered private", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "aggregate_count": { "title": "Aggregate count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamRirsId" }, "task": true }, { "name": "patchIpamRirsId", "summary": "ipam_rirs_partial_update", "description": "ipam_rirs_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this RIR.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"is_private\": \"boolean\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"aggregate_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "is_private": { "title": "Private", "description": "IP space managed by this RIR is considered private", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "aggregate_count": { "title": "Aggregate count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamRirsId" }, "task": true }, { "name": "deleteIpamRirsId", "summary": "ipam_rirs_delete", "description": "ipam_rirs_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this RIR.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamRirsId" }, "task": true }, { "name": "getIpamRoles", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamRoles" }, "task": true }, { "name": "postIpamRoles", "summary": "ipam_roles_create", "description": "ipam_roles_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"weight\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamRoles" }, "task": true }, { "name": "putIpamRoles", "summary": "ipam_roles_bulk_update", "description": "ipam_roles_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"weight\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamRoles" }, "task": true }, { "name": "patchIpamRoles", "summary": "ipam_roles_bulk_partial_update", "description": "ipam_roles_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"weight\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamRoles" }, "task": true }, { "name": "deleteIpamRoles", "summary": "ipam_roles_bulk_delete", "description": "ipam_roles_bulk_delete", "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": "/deleteIpamRoles" }, "task": true }, { "name": "getIpamRolesId", "summary": "ipam_roles_read", "description": "ipam_roles_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this role.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamRolesId" }, "task": true }, { "name": "putIpamRolesId", "summary": "ipam_roles_update", "description": "ipam_roles_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"weight\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamRolesId" }, "task": true }, { "name": "patchIpamRolesId", "summary": "ipam_roles_partial_update", "description": "ipam_roles_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"weight\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123, \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamRolesId" }, "task": true }, { "name": "deleteIpamRolesId", "summary": "ipam_roles_delete", "description": "ipam_roles_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this role.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamRolesId" }, "task": true }, { "name": "getIpamRouteTargets", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "importingVrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "importingVrfId", "type": "string" } }, { "name": "importingVrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "importingVrf", "type": "string" } }, { "name": "exportingVrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportingVrfId", "type": "string" } }, { "name": "exportingVrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportingVrf", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "importingVrfIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "importingVrfIdN", "type": "string" } }, { "name": "importingVrfN", "type": "string", "info": ": string", "required": false, "schema": { "title": "importingVrfN", "type": "string" } }, { "name": "exportingVrfIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportingVrfIdN", "type": "string" } }, { "name": "exportingVrfN", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportingVrfN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamRouteTargets" }, "task": true }, { "name": "postIpamRouteTargets", "summary": "ipam_route-targets_create", "description": "ipam_route-targets_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamRouteTargets" }, "task": true }, { "name": "putIpamRouteTargets", "summary": "ipam_route-targets_bulk_update", "description": "ipam_route-targets_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamRouteTargets" }, "task": true }, { "name": "patchIpamRouteTargets", "summary": "ipam_route-targets_bulk_partial_update", "description": "ipam_route-targets_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamRouteTargets" }, "task": true }, { "name": "deleteIpamRouteTargets", "summary": "ipam_route-targets_bulk_delete", "description": "ipam_route-targets_bulk_delete", "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": "/deleteIpamRouteTargets" }, "task": true }, { "name": "getIpamRouteTargetsId", "summary": "ipam_route-targets_read", "description": "ipam_route-targets_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this route target.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamRouteTargetsId" }, "task": true }, { "name": "putIpamRouteTargetsId", "summary": "ipam_route-targets_update", "description": "ipam_route-targets_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this route target.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamRouteTargetsId" }, "task": true }, { "name": "patchIpamRouteTargetsId", "summary": "ipam_route-targets_partial_update", "description": "ipam_route-targets_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this route target.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"tenant\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamRouteTargetsId" }, "task": true }, { "name": "deleteIpamRouteTargetsId", "summary": "ipam_route-targets_delete", "description": "ipam_route-targets_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this route target.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamRouteTargetsId" }, "task": true }, { "name": "getIpamServiceTemplates", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "protocol", "type": "string", "info": ": string", "required": false, "schema": { "title": "protocol", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "port", "type": "number", "info": ": 123", "required": false, "schema": { "title": "port", "type": "number" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "protocolN", "type": "string", "info": ": string", "required": false, "schema": { "title": "protocolN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "ports" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "TCP", "UDP", "SCTP" ] }, "value": { "type": "string", "enum": [ "tcp", "udp", "sctp" ] } } }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamServiceTemplates" }, "task": true }, { "name": "postIpamServiceTemplates", "summary": "ipam_service-templates_create", "description": "ipam_service-templates_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamServiceTemplates" }, "task": true }, { "name": "putIpamServiceTemplates", "summary": "ipam_service-templates_bulk_update", "description": "ipam_service-templates_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamServiceTemplates" }, "task": true }, { "name": "patchIpamServiceTemplates", "summary": "ipam_service-templates_bulk_partial_update", "description": "ipam_service-templates_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamServiceTemplates" }, "task": true }, { "name": "deleteIpamServiceTemplates", "summary": "ipam_service-templates_bulk_delete", "description": "ipam_service-templates_bulk_delete", "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": "/deleteIpamServiceTemplates" }, "task": true }, { "name": "getIpamServiceTemplatesId", "summary": "ipam_service-templates_read", "description": "ipam_service-templates_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service template.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamServiceTemplatesId" }, "task": true }, { "name": "putIpamServiceTemplatesId", "summary": "ipam_service-templates_update", "description": "ipam_service-templates_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamServiceTemplatesId" }, "task": true }, { "name": "patchIpamServiceTemplatesId", "summary": "ipam_service-templates_partial_update", "description": "ipam_service-templates_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service template.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamServiceTemplatesId" }, "task": true }, { "name": "deleteIpamServiceTemplatesId", "summary": "ipam_service-templates_delete", "description": "ipam_service-templates_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service template.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamServiceTemplatesId" }, "task": true }, { "name": "getIpamServices", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "protocol", "type": "string", "info": ": string", "required": false, "schema": { "title": "protocol", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "virtualMachineId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineId", "type": "string" } }, { "name": "virtualMachine", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachine", "type": "string" } }, { "name": "port", "type": "number", "info": ": 123", "required": false, "schema": { "title": "port", "type": "number" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "protocolN", "type": "string", "info": ": string", "required": false, "schema": { "title": "protocolN", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "virtualMachineIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineIdN", "type": "string" } }, { "name": "virtualMachineN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "ports" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "virtual_machine": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "TCP", "UDP", "SCTP" ] }, "value": { "type": "string", "enum": [ "tcp", "udp", "sctp" ] } } }, "ipaddresses": { "type": "array", "items": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamServices" }, "task": true }, { "name": "postIpamServices", "summary": "ipam_services_create", "description": "ipam_services_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"virtual_machine\": 123, \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"ipaddresses\": \"array\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "ipaddresses": { "type": "array", "items": { "title": "IP addresses", "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamServices" }, "task": true }, { "name": "putIpamServices", "summary": "ipam_services_bulk_update", "description": "ipam_services_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"virtual_machine\": 123, \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"ipaddresses\": \"array\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "ipaddresses": { "type": "array", "items": { "title": "IP addresses", "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamServices" }, "task": true }, { "name": "patchIpamServices", "summary": "ipam_services_bulk_partial_update", "description": "ipam_services_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"virtual_machine\": 123, \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"ipaddresses\": \"array\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "ipaddresses": { "type": "array", "items": { "title": "IP addresses", "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamServices" }, "task": true }, { "name": "deleteIpamServices", "summary": "ipam_services_bulk_delete", "description": "ipam_services_bulk_delete", "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": "/deleteIpamServices" }, "task": true }, { "name": "getIpamServicesId", "summary": "ipam_services_read", "description": "ipam_services_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamServicesId" }, "task": true }, { "name": "putIpamServicesId", "summary": "ipam_services_update", "description": "ipam_services_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"virtual_machine\": 123, \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"ipaddresses\": \"array\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "ipaddresses": { "type": "array", "items": { "title": "IP addresses", "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamServicesId" }, "task": true }, { "name": "patchIpamServicesId", "summary": "ipam_services_partial_update", "description": "ipam_services_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"device\": 123, \"virtual_machine\": 123, \"name\": \"string\", \"ports\": \"array\", \"protocol\": \"Must be one of [tcp, udp, sctp]\", \"ipaddresses\": \"array\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "ports", "protocol" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "ports": { "type": "array", "items": { "title": "Ports", "type": "integer", "maximum": 65535, "minimum": 1 } }, "protocol": { "title": "Protocol", "type": "string", "enum": [ "tcp", "udp", "sctp" ] }, "ipaddresses": { "type": "array", "items": { "title": "IP addresses", "type": "integer" }, "uniqueItems": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamServicesId" }, "task": true }, { "name": "deleteIpamServicesId", "summary": "ipam_services_delete", "description": "ipam_services_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamServicesId" }, "task": true }, { "name": "getIpamVlanGroups", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "minVid", "type": "string", "info": ": string", "required": false, "schema": { "title": "minVid", "type": "string" } }, { "name": "maxVid", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxVid", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "scopeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "scopeId", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "scopeType", "type": "string", "info": ": string", "required": false, "schema": { "title": "scopeType", "type": "string" } }, { "name": "region", "type": "number", "info": ": 123", "required": false, "schema": { "title": "region", "type": "number" } }, { "name": "sitegroup", "type": "number", "info": ": 123", "required": false, "schema": { "title": "sitegroup", "type": "number" } }, { "name": "site", "type": "number", "info": ": 123", "required": false, "schema": { "title": "site", "type": "number" } }, { "name": "location", "type": "number", "info": ": 123", "required": false, "schema": { "title": "location", "type": "number" } }, { "name": "rack", "type": "number", "info": ": 123", "required": false, "schema": { "title": "rack", "type": "number" } }, { "name": "clustergroup", "type": "number", "info": ": 123", "required": false, "schema": { "title": "clustergroup", "type": "number" } }, { "name": "cluster", "type": "number", "info": ": 123", "required": false, "schema": { "title": "cluster", "type": "number" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "minVidN", "type": "string", "info": ": string", "required": false, "schema": { "title": "minVidN", "type": "string" } }, { "name": "minVidLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "minVidLte", "type": "string" } }, { "name": "minVidLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "minVidLt", "type": "string" } }, { "name": "minVidGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "minVidGte", "type": "string" } }, { "name": "minVidGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "minVidGt", "type": "string" } }, { "name": "maxVidN", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxVidN", "type": "string" } }, { "name": "maxVidLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxVidLte", "type": "string" } }, { "name": "maxVidLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxVidLt", "type": "string" } }, { "name": "maxVidGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxVidGte", "type": "string" } }, { "name": "maxVidGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "maxVidGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "scopeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "scopeIdN", "type": "string" } }, { "name": "scopeIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "scopeIdLte", "type": "string" } }, { "name": "scopeIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "scopeIdLt", "type": "string" } }, { "name": "scopeIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "scopeIdGte", "type": "string" } }, { "name": "scopeIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "scopeIdGt", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "scopeTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "scopeTypeN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "scope_type": { "title": "Scope type", "type": "string" }, "scope_id": { "title": "Scope id", "type": "integer", "x-nullable": true }, "scope": { "title": "Scope", "type": "object", "readOnly": true }, "min_vid": { "title": "Minimum VLAN ID", "description": "Lowest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "max_vid": { "title": "Maximum VLAN ID", "description": "Highest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamVlanGroups" }, "task": true }, { "name": "postIpamVlanGroups", "summary": "ipam_vlan-groups_create", "description": "ipam_vlan-groups_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"scope_type\": \"string\", \"scope_id\": 123, \"scope\": \"object\", \"min_vid\": 123, \"max_vid\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "scope_type": { "title": "Scope type", "type": "string" }, "scope_id": { "title": "Scope id", "type": "integer", "x-nullable": true }, "scope": { "title": "Scope", "type": "object", "readOnly": true }, "min_vid": { "title": "Minimum VLAN ID", "description": "Lowest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "max_vid": { "title": "Maximum VLAN ID", "description": "Highest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamVlanGroups" }, "task": true }, { "name": "putIpamVlanGroups", "summary": "ipam_vlan-groups_bulk_update", "description": "ipam_vlan-groups_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"scope_type\": \"string\", \"scope_id\": 123, \"scope\": \"object\", \"min_vid\": 123, \"max_vid\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "scope_type": { "title": "Scope type", "type": "string" }, "scope_id": { "title": "Scope id", "type": "integer", "x-nullable": true }, "scope": { "title": "Scope", "type": "object", "readOnly": true }, "min_vid": { "title": "Minimum VLAN ID", "description": "Lowest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "max_vid": { "title": "Maximum VLAN ID", "description": "Highest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamVlanGroups" }, "task": true }, { "name": "patchIpamVlanGroups", "summary": "ipam_vlan-groups_bulk_partial_update", "description": "ipam_vlan-groups_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"scope_type\": \"string\", \"scope_id\": 123, \"scope\": \"object\", \"min_vid\": 123, \"max_vid\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "scope_type": { "title": "Scope type", "type": "string" }, "scope_id": { "title": "Scope id", "type": "integer", "x-nullable": true }, "scope": { "title": "Scope", "type": "object", "readOnly": true }, "min_vid": { "title": "Minimum VLAN ID", "description": "Lowest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "max_vid": { "title": "Maximum VLAN ID", "description": "Highest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamVlanGroups" }, "task": true }, { "name": "deleteIpamVlanGroups", "summary": "ipam_vlan-groups_bulk_delete", "description": "ipam_vlan-groups_bulk_delete", "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": "/deleteIpamVlanGroups" }, "task": true }, { "name": "getIpamVlanGroupsId", "summary": "ipam_vlan-groups_read", "description": "ipam_vlan-groups_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN group.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamVlanGroupsId" }, "task": true }, { "name": "putIpamVlanGroupsId", "summary": "ipam_vlan-groups_update", "description": "ipam_vlan-groups_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"scope_type\": \"string\", \"scope_id\": 123, \"scope\": \"object\", \"min_vid\": 123, \"max_vid\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "scope_type": { "title": "Scope type", "type": "string" }, "scope_id": { "title": "Scope id", "type": "integer", "x-nullable": true }, "scope": { "title": "Scope", "type": "object", "readOnly": true }, "min_vid": { "title": "Minimum VLAN ID", "description": "Lowest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "max_vid": { "title": "Maximum VLAN ID", "description": "Highest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamVlanGroupsId" }, "task": true }, { "name": "patchIpamVlanGroupsId", "summary": "ipam_vlan-groups_partial_update", "description": "ipam_vlan-groups_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"scope_type\": \"string\", \"scope_id\": 123, \"scope\": \"object\", \"min_vid\": 123, \"max_vid\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"vlan_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "scope_type": { "title": "Scope type", "type": "string" }, "scope_id": { "title": "Scope id", "type": "integer", "x-nullable": true }, "scope": { "title": "Scope", "type": "object", "readOnly": true }, "min_vid": { "title": "Minimum VLAN ID", "description": "Lowest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "max_vid": { "title": "Maximum VLAN ID", "description": "Highest permissible ID of a child VLAN", "type": "integer", "maximum": 4094, "minimum": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamVlanGroupsId" }, "task": true }, { "name": "deleteIpamVlanGroupsId", "summary": "ipam_vlan-groups_delete", "description": "ipam_vlan-groups_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN group.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamVlanGroupsId" }, "task": true }, { "name": "getIpamVlanGroupsIdAvailableVlans", "summary": "ipam_vlan-groups_available-vlans_list", "description": "ipam_vlan-groups_available-vlans_list", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN.: 123", "required": true, "schema": { "title": "id", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "object", "properties": { "vid": { "title": "Vid", "type": "integer", "readOnly": true }, "group": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamVlanGroupsIdAvailableVlans" }, "task": true }, { "name": "postIpamVlanGroupsIdAvailableVlans", "summary": "ipam_vlan-groups_available-vlans_create", "description": "ipam_vlan-groups_available-vlans_create", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"name\": \"string\", \"site\": 123, \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "group": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } } }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Active", "Reserved", "Deprecated" ] }, "value": { "type": "string", "enum": [ "active", "reserved", "deprecated" ] } } }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "l2vpn_termination": { "required": [ "l2vpn" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] } } } } }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamVlanGroupsIdAvailableVlans" }, "task": true }, { "name": "getIpamVlans", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "vid", "type": "string", "info": ": string", "required": false, "schema": { "title": "vid", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "group", "type": "string", "info": ": string", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "availableOnDevice", "type": "string", "info": ": string", "required": false, "schema": { "title": "availableOnDevice", "type": "string" } }, { "name": "availableOnVirtualmachine", "type": "string", "info": ": string", "required": false, "schema": { "title": "availableOnVirtualmachine", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "vidN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vidN", "type": "string" } }, { "name": "vidLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "vidLte", "type": "string" } }, { "name": "vidLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "vidLt", "type": "string" } }, { "name": "vidGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "vidGte", "type": "string" } }, { "name": "vidGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "vidGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "group": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } } }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Active", "Reserved", "Deprecated" ] }, "value": { "type": "string", "enum": [ "active", "reserved", "deprecated" ] } } }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "l2vpn_termination": { "required": [ "l2vpn" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] } } } } }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamVlans" }, "task": true }, { "name": "postIpamVlans", "summary": "ipam_vlans_create", "description": "ipam_vlans_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"group\": 123, \"vid\": 123, \"name\": \"string\", \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123}", "required": true, "schema": { "required": [ "group", "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamVlans" }, "task": true }, { "name": "putIpamVlans", "summary": "ipam_vlans_bulk_update", "description": "ipam_vlans_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"group\": 123, \"vid\": 123, \"name\": \"string\", \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123}", "required": true, "schema": { "required": [ "group", "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamVlans" }, "task": true }, { "name": "patchIpamVlans", "summary": "ipam_vlans_bulk_partial_update", "description": "ipam_vlans_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"group\": 123, \"vid\": 123, \"name\": \"string\", \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123}", "required": true, "schema": { "required": [ "group", "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamVlans" }, "task": true }, { "name": "deleteIpamVlans", "summary": "ipam_vlans_bulk_delete", "description": "ipam_vlans_bulk_delete", "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": "/deleteIpamVlans" }, "task": true }, { "name": "getIpamVlansId", "summary": "ipam_vlans_read", "description": "ipam_vlans_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamVlansId" }, "task": true }, { "name": "putIpamVlansId", "summary": "ipam_vlans_update", "description": "ipam_vlans_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"group\": 123, \"vid\": 123, \"name\": \"string\", \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123}", "required": true, "schema": { "required": [ "group", "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamVlansId" }, "task": true }, { "name": "patchIpamVlansId", "summary": "ipam_vlans_partial_update", "description": "ipam_vlans_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"site\": 123, \"group\": 123, \"vid\": 123, \"name\": \"string\", \"tenant\": 123, \"status\": \"Must be one of [active, reserved, deprecated]\", \"role\": 123, \"description\": \"string\", \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"prefix_count\": 123}", "required": true, "schema": { "required": [ "group", "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "reserved", "deprecated" ] }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamVlansId" }, "task": true }, { "name": "deleteIpamVlansId", "summary": "ipam_vlans_delete", "description": "ipam_vlans_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VLAN.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamVlansId" }, "task": true }, { "name": "getIpamVrfs", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "rd", "type": "string", "info": ": string", "required": false, "schema": { "title": "rd", "type": "string" } }, { "name": "enforceUnique", "type": "string", "info": ": string", "required": false, "schema": { "title": "enforceUnique", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "importTargetId", "type": "string", "info": ": string", "required": false, "schema": { "title": "importTargetId", "type": "string" } }, { "name": "importTarget", "type": "string", "info": ": string", "required": false, "schema": { "title": "importTarget", "type": "string" } }, { "name": "exportTargetId", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportTargetId", "type": "string" } }, { "name": "exportTarget", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportTarget", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "rdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdN", "type": "string" } }, { "name": "rdIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdIc", "type": "string" } }, { "name": "rdNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdNic", "type": "string" } }, { "name": "rdIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdIew", "type": "string" } }, { "name": "rdNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdNiew", "type": "string" } }, { "name": "rdIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdIsw", "type": "string" } }, { "name": "rdNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdNisw", "type": "string" } }, { "name": "rdIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdIe", "type": "string" } }, { "name": "rdNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "rdNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "importTargetIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "importTargetIdN", "type": "string" } }, { "name": "importTargetN", "type": "string", "info": ": string", "required": false, "schema": { "title": "importTargetN", "type": "string" } }, { "name": "exportTargetIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportTargetIdN", "type": "string" } }, { "name": "exportTargetN", "type": "string", "info": ": string", "required": false, "schema": { "title": "exportTargetN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "enforce_unique": { "title": "Enforce unique space", "description": "Prevent duplicate prefixes/IP addresses within this VRF", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "import_targets": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 } } }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "description": "Route target value (formatted in accordance with RFC 4360)", "type": "string", "maxLength": 21, "minLength": 1 } } }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamVrfs" }, "task": true }, { "name": "postIpamVrfs", "summary": "ipam_vrfs_create", "description": "ipam_vrfs_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"rd\": \"string\", \"tenant\": 123, \"enforce_unique\": \"boolean\", \"description\": \"string\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"ipaddress_count\": 123, \"prefix_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "enforce_unique": { "title": "Enforce unique space", "description": "Prevent duplicate prefixes/IP addresses within this VRF", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpamVrfs" }, "task": true }, { "name": "putIpamVrfs", "summary": "ipam_vrfs_bulk_update", "description": "ipam_vrfs_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"rd\": \"string\", \"tenant\": 123, \"enforce_unique\": \"boolean\", \"description\": \"string\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"ipaddress_count\": 123, \"prefix_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "enforce_unique": { "title": "Enforce unique space", "description": "Prevent duplicate prefixes/IP addresses within this VRF", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamVrfs" }, "task": true }, { "name": "patchIpamVrfs", "summary": "ipam_vrfs_bulk_partial_update", "description": "ipam_vrfs_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"rd\": \"string\", \"tenant\": 123, \"enforce_unique\": \"boolean\", \"description\": \"string\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"ipaddress_count\": 123, \"prefix_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "enforce_unique": { "title": "Enforce unique space", "description": "Prevent duplicate prefixes/IP addresses within this VRF", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamVrfs" }, "task": true }, { "name": "deleteIpamVrfs", "summary": "ipam_vrfs_bulk_delete", "description": "ipam_vrfs_bulk_delete", "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": "/deleteIpamVrfs" }, "task": true }, { "name": "getIpamVrfsId", "summary": "ipam_vrfs_read", "description": "ipam_vrfs_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VRF.: 123", "required": true, "schema": { "title": "id", "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": "/getIpamVrfsId" }, "task": true }, { "name": "putIpamVrfsId", "summary": "ipam_vrfs_update", "description": "ipam_vrfs_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VRF.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"rd\": \"string\", \"tenant\": 123, \"enforce_unique\": \"boolean\", \"description\": \"string\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"ipaddress_count\": 123, \"prefix_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "enforce_unique": { "title": "Enforce unique space", "description": "Prevent duplicate prefixes/IP addresses within this VRF", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putIpamVrfsId" }, "task": true }, { "name": "patchIpamVrfsId", "summary": "ipam_vrfs_partial_update", "description": "ipam_vrfs_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VRF.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"rd\": \"string\", \"tenant\": 123, \"enforce_unique\": \"boolean\", \"description\": \"string\", \"import_targets\": \"array\", \"export_targets\": \"array\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"ipaddress_count\": 123, \"prefix_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "enforce_unique": { "title": "Enforce unique space", "description": "Prevent duplicate prefixes/IP addresses within this VRF", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "import_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "export_targets": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchIpamVrfsId" }, "task": true }, { "name": "deleteIpamVrfsId", "summary": "ipam_vrfs_delete", "description": "ipam_vrfs_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this VRF.: 123", "required": true, "schema": { "title": "id", "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": "/deleteIpamVrfsId" }, "task": true }, { "name": "getStatus", "summary": "A lightweight read-only endpoint for conveying NetBox's current operational status.", "description": "A lightweight read-only endpoint for conveying NetBox's current operational status.", "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": "/getStatus" }, "task": true }, { "name": "getTenancyContactAssignments", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "contentTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeId", "type": "string" } }, { "name": "objectId", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectId", "type": "string" } }, { "name": "priority", "type": "string", "info": ": string", "required": false, "schema": { "title": "priority", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "contentType", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentType", "type": "string" } }, { "name": "contactId", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactId", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "contentTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdN", "type": "string" } }, { "name": "objectIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdN", "type": "string" } }, { "name": "objectIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdLte", "type": "string" } }, { "name": "objectIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdLt", "type": "string" } }, { "name": "objectIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdGte", "type": "string" } }, { "name": "objectIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectIdGt", "type": "string" } }, { "name": "priorityN", "type": "string", "info": ": string", "required": false, "schema": { "title": "priorityN", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "contentTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeN", "type": "string" } }, { "name": "contactIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactIdN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "content_type", "object_id", "contact" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "object": { "title": "Object", "type": "object", "readOnly": true }, "contact": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 } } }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "priority": { "title": "Priority", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Primary", "Secondary", "Tertiary", "Inactive" ] }, "value": { "type": "string", "enum": [ "primary", "secondary", "tertiary", "inactive" ] } } }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTenancyContactAssignments" }, "task": true }, { "name": "postTenancyContactAssignments", "summary": "tenancy_contact-assignments_create", "description": "tenancy_contact-assignments_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"object\": \"object\", \"contact\": 123, \"role\": 123, \"priority\": \"Must be one of [primary, secondary, tertiary, inactive]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "contact", "role", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "object": { "title": "Object", "type": "object", "readOnly": true }, "contact": { "title": "Contact", "type": "integer" }, "role": { "title": "Role", "type": "integer" }, "priority": { "title": "Priority", "type": "string", "enum": [ "primary", "secondary", "tertiary", "inactive" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTenancyContactAssignments" }, "task": true }, { "name": "putTenancyContactAssignments", "summary": "tenancy_contact-assignments_bulk_update", "description": "tenancy_contact-assignments_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"object\": \"object\", \"contact\": 123, \"role\": 123, \"priority\": \"Must be one of [primary, secondary, tertiary, inactive]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "contact", "role", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "object": { "title": "Object", "type": "object", "readOnly": true }, "contact": { "title": "Contact", "type": "integer" }, "role": { "title": "Role", "type": "integer" }, "priority": { "title": "Priority", "type": "string", "enum": [ "primary", "secondary", "tertiary", "inactive" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyContactAssignments" }, "task": true }, { "name": "patchTenancyContactAssignments", "summary": "tenancy_contact-assignments_bulk_partial_update", "description": "tenancy_contact-assignments_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"object\": \"object\", \"contact\": 123, \"role\": 123, \"priority\": \"Must be one of [primary, secondary, tertiary, inactive]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "contact", "role", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "object": { "title": "Object", "type": "object", "readOnly": true }, "contact": { "title": "Contact", "type": "integer" }, "role": { "title": "Role", "type": "integer" }, "priority": { "title": "Priority", "type": "string", "enum": [ "primary", "secondary", "tertiary", "inactive" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyContactAssignments" }, "task": true }, { "name": "deleteTenancyContactAssignments", "summary": "tenancy_contact-assignments_bulk_delete", "description": "tenancy_contact-assignments_bulk_delete", "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": "/deleteTenancyContactAssignments" }, "task": true }, { "name": "getTenancyContactAssignmentsId", "summary": "tenancy_contact-assignments_read", "description": "tenancy_contact-assignments_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact assignment.: 123", "required": true, "schema": { "title": "id", "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": "/getTenancyContactAssignmentsId" }, "task": true }, { "name": "putTenancyContactAssignmentsId", "summary": "tenancy_contact-assignments_update", "description": "tenancy_contact-assignments_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact assignment.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"object\": \"object\", \"contact\": 123, \"role\": 123, \"priority\": \"Must be one of [primary, secondary, tertiary, inactive]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "contact", "role", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "object": { "title": "Object", "type": "object", "readOnly": true }, "contact": { "title": "Contact", "type": "integer" }, "role": { "title": "Role", "type": "integer" }, "priority": { "title": "Priority", "type": "string", "enum": [ "primary", "secondary", "tertiary", "inactive" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyContactAssignmentsId" }, "task": true }, { "name": "patchTenancyContactAssignmentsId", "summary": "tenancy_contact-assignments_partial_update", "description": "tenancy_contact-assignments_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact assignment.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_type\": \"string\", \"object_id\": 123, \"object\": \"object\", \"contact\": 123, \"role\": 123, \"priority\": \"Must be one of [primary, secondary, tertiary, inactive]\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_type", "object_id", "contact", "role", "priority" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_type": { "title": "Content type", "type": "string" }, "object_id": { "title": "Object id", "type": "integer", "maximum": 9223372036854776000, "minimum": 0 }, "object": { "title": "Object", "type": "object", "readOnly": true }, "contact": { "title": "Contact", "type": "integer" }, "role": { "title": "Role", "type": "integer" }, "priority": { "title": "Priority", "type": "string", "enum": [ "primary", "secondary", "tertiary", "inactive" ] }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyContactAssignmentsId" }, "task": true }, { "name": "deleteTenancyContactAssignmentsId", "summary": "tenancy_contact-assignments_delete", "description": "tenancy_contact-assignments_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact assignment.: 123", "required": true, "schema": { "title": "id", "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": "/deleteTenancyContactAssignmentsId" }, "task": true }, { "name": "getTenancyContactGroups", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "parent", "type": "string", "info": ": string", "required": false, "schema": { "title": "parent", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "parentN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "contact_count": { "title": "Contact count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "contact_count": { "title": "Contact count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTenancyContactGroups" }, "task": true }, { "name": "postTenancyContactGroups", "summary": "tenancy_contact-groups_create", "description": "tenancy_contact-groups_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"contact_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "contact_count": { "title": "Contact count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTenancyContactGroups" }, "task": true }, { "name": "putTenancyContactGroups", "summary": "tenancy_contact-groups_bulk_update", "description": "tenancy_contact-groups_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"contact_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "contact_count": { "title": "Contact count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyContactGroups" }, "task": true }, { "name": "patchTenancyContactGroups", "summary": "tenancy_contact-groups_bulk_partial_update", "description": "tenancy_contact-groups_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"contact_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "contact_count": { "title": "Contact count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyContactGroups" }, "task": true }, { "name": "deleteTenancyContactGroups", "summary": "tenancy_contact-groups_bulk_delete", "description": "tenancy_contact-groups_bulk_delete", "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": "/deleteTenancyContactGroups" }, "task": true }, { "name": "getTenancyContactGroupsId", "summary": "tenancy_contact-groups_read", "description": "tenancy_contact-groups_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact group.: 123", "required": true, "schema": { "title": "id", "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": "/getTenancyContactGroupsId" }, "task": true }, { "name": "putTenancyContactGroupsId", "summary": "tenancy_contact-groups_update", "description": "tenancy_contact-groups_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"contact_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "contact_count": { "title": "Contact count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyContactGroupsId" }, "task": true }, { "name": "patchTenancyContactGroupsId", "summary": "tenancy_contact-groups_partial_update", "description": "tenancy_contact-groups_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"contact_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "contact_count": { "title": "Contact count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyContactGroupsId" }, "task": true }, { "name": "deleteTenancyContactGroupsId", "summary": "tenancy_contact-groups_delete", "description": "tenancy_contact-groups_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact group.: 123", "required": true, "schema": { "title": "id", "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": "/deleteTenancyContactGroupsId" }, "task": true }, { "name": "getTenancyContactRoles", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTenancyContactRoles" }, "task": true }, { "name": "postTenancyContactRoles", "summary": "tenancy_contact-roles_create", "description": "tenancy_contact-roles_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTenancyContactRoles" }, "task": true }, { "name": "putTenancyContactRoles", "summary": "tenancy_contact-roles_bulk_update", "description": "tenancy_contact-roles_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyContactRoles" }, "task": true }, { "name": "patchTenancyContactRoles", "summary": "tenancy_contact-roles_bulk_partial_update", "description": "tenancy_contact-roles_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyContactRoles" }, "task": true }, { "name": "deleteTenancyContactRoles", "summary": "tenancy_contact-roles_bulk_delete", "description": "tenancy_contact-roles_bulk_delete", "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": "/deleteTenancyContactRoles" }, "task": true }, { "name": "getTenancyContactRolesId", "summary": "tenancy_contact-roles_read", "description": "tenancy_contact-roles_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact role.: 123", "required": true, "schema": { "title": "id", "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": "/getTenancyContactRolesId" }, "task": true }, { "name": "putTenancyContactRolesId", "summary": "tenancy_contact-roles_update", "description": "tenancy_contact-roles_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyContactRolesId" }, "task": true }, { "name": "patchTenancyContactRolesId", "summary": "tenancy_contact-roles_partial_update", "description": "tenancy_contact-roles_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact role.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyContactRolesId" }, "task": true }, { "name": "deleteTenancyContactRolesId", "summary": "tenancy_contact-roles_delete", "description": "tenancy_contact-roles_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact role.: 123", "required": true, "schema": { "title": "id", "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": "/deleteTenancyContactRolesId" }, "task": true }, { "name": "getTenancyContacts", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "title", "type": "string", "info": ": string", "required": false, "schema": { "title": "title", "type": "string" } }, { "name": "phone", "type": "string", "info": ": string", "required": false, "schema": { "title": "phone", "type": "string" } }, { "name": "email", "type": "string", "info": ": string", "required": false, "schema": { "title": "email", "type": "string" } }, { "name": "address", "type": "string", "info": ": string", "required": false, "schema": { "title": "address", "type": "string" } }, { "name": "link", "type": "string", "info": ": string", "required": false, "schema": { "title": "link", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "group", "type": "string", "info": ": string", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "titleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleN", "type": "string" } }, { "name": "titleIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleIc", "type": "string" } }, { "name": "titleNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleNic", "type": "string" } }, { "name": "titleIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleIew", "type": "string" } }, { "name": "titleNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleNiew", "type": "string" } }, { "name": "titleIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleIsw", "type": "string" } }, { "name": "titleNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleNisw", "type": "string" } }, { "name": "titleIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleIe", "type": "string" } }, { "name": "titleNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "titleNie", "type": "string" } }, { "name": "phoneN", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneN", "type": "string" } }, { "name": "phoneIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneIc", "type": "string" } }, { "name": "phoneNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneNic", "type": "string" } }, { "name": "phoneIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneIew", "type": "string" } }, { "name": "phoneNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneNiew", "type": "string" } }, { "name": "phoneIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneIsw", "type": "string" } }, { "name": "phoneNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneNisw", "type": "string" } }, { "name": "phoneIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneIe", "type": "string" } }, { "name": "phoneNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "phoneNie", "type": "string" } }, { "name": "emailN", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailN", "type": "string" } }, { "name": "emailIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailIc", "type": "string" } }, { "name": "emailNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailNic", "type": "string" } }, { "name": "emailIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailIew", "type": "string" } }, { "name": "emailNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailNiew", "type": "string" } }, { "name": "emailIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailIsw", "type": "string" } }, { "name": "emailNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailNisw", "type": "string" } }, { "name": "emailIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailIe", "type": "string" } }, { "name": "emailNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailNie", "type": "string" } }, { "name": "addressN", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressN", "type": "string" } }, { "name": "addressIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressIc", "type": "string" } }, { "name": "addressNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressNic", "type": "string" } }, { "name": "addressIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressIew", "type": "string" } }, { "name": "addressNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressNiew", "type": "string" } }, { "name": "addressIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressIsw", "type": "string" } }, { "name": "addressNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressNisw", "type": "string" } }, { "name": "addressIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressIe", "type": "string" } }, { "name": "addressNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "addressNie", "type": "string" } }, { "name": "linkN", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkN", "type": "string" } }, { "name": "linkIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkIc", "type": "string" } }, { "name": "linkNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkNic", "type": "string" } }, { "name": "linkIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkIew", "type": "string" } }, { "name": "linkNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkNiew", "type": "string" } }, { "name": "linkIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkIsw", "type": "string" } }, { "name": "linkNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkNisw", "type": "string" } }, { "name": "linkIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkIe", "type": "string" } }, { "name": "linkNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "linkNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "contact_count": { "title": "Contact count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "title": { "title": "Title", "type": "string", "maxLength": 100 }, "phone": { "title": "Phone", "type": "string", "maxLength": 50 }, "email": { "title": "Email", "type": "string", "maxLength": 254 }, "address": { "title": "Address", "type": "string", "maxLength": 200 }, "link": { "title": "Link", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTenancyContacts" }, "task": true }, { "name": "postTenancyContacts", "summary": "tenancy_contacts_create", "description": "tenancy_contacts_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"name\": \"string\", \"title\": \"string\", \"phone\": \"string\", \"email\": \"string\", \"address\": \"string\", \"link\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "title": { "title": "Title", "type": "string", "maxLength": 100 }, "phone": { "title": "Phone", "type": "string", "maxLength": 50 }, "email": { "title": "Email", "type": "string", "maxLength": 254 }, "address": { "title": "Address", "type": "string", "maxLength": 200 }, "link": { "title": "Link", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTenancyContacts" }, "task": true }, { "name": "putTenancyContacts", "summary": "tenancy_contacts_bulk_update", "description": "tenancy_contacts_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"name\": \"string\", \"title\": \"string\", \"phone\": \"string\", \"email\": \"string\", \"address\": \"string\", \"link\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "title": { "title": "Title", "type": "string", "maxLength": 100 }, "phone": { "title": "Phone", "type": "string", "maxLength": 50 }, "email": { "title": "Email", "type": "string", "maxLength": 254 }, "address": { "title": "Address", "type": "string", "maxLength": 200 }, "link": { "title": "Link", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyContacts" }, "task": true }, { "name": "patchTenancyContacts", "summary": "tenancy_contacts_bulk_partial_update", "description": "tenancy_contacts_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"name\": \"string\", \"title\": \"string\", \"phone\": \"string\", \"email\": \"string\", \"address\": \"string\", \"link\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "title": { "title": "Title", "type": "string", "maxLength": 100 }, "phone": { "title": "Phone", "type": "string", "maxLength": 50 }, "email": { "title": "Email", "type": "string", "maxLength": 254 }, "address": { "title": "Address", "type": "string", "maxLength": 200 }, "link": { "title": "Link", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyContacts" }, "task": true }, { "name": "deleteTenancyContacts", "summary": "tenancy_contacts_bulk_delete", "description": "tenancy_contacts_bulk_delete", "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": "/deleteTenancyContacts" }, "task": true }, { "name": "getTenancyContactsId", "summary": "tenancy_contacts_read", "description": "tenancy_contacts_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact.: 123", "required": true, "schema": { "title": "id", "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": "/getTenancyContactsId" }, "task": true }, { "name": "putTenancyContactsId", "summary": "tenancy_contacts_update", "description": "tenancy_contacts_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"name\": \"string\", \"title\": \"string\", \"phone\": \"string\", \"email\": \"string\", \"address\": \"string\", \"link\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "title": { "title": "Title", "type": "string", "maxLength": 100 }, "phone": { "title": "Phone", "type": "string", "maxLength": 50 }, "email": { "title": "Email", "type": "string", "maxLength": 254 }, "address": { "title": "Address", "type": "string", "maxLength": 200 }, "link": { "title": "Link", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyContactsId" }, "task": true }, { "name": "patchTenancyContactsId", "summary": "tenancy_contacts_partial_update", "description": "tenancy_contacts_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"group\": 123, \"name\": \"string\", \"title\": \"string\", \"phone\": \"string\", \"email\": \"string\", \"address\": \"string\", \"link\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "group", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "title": { "title": "Title", "type": "string", "maxLength": 100 }, "phone": { "title": "Phone", "type": "string", "maxLength": 50 }, "email": { "title": "Email", "type": "string", "maxLength": 254 }, "address": { "title": "Address", "type": "string", "maxLength": 200 }, "link": { "title": "Link", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyContactsId" }, "task": true }, { "name": "deleteTenancyContactsId", "summary": "tenancy_contacts_delete", "description": "tenancy_contacts_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this contact.: 123", "required": true, "schema": { "title": "id", "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": "/deleteTenancyContactsId" }, "task": true }, { "name": "getTenancyTenantGroups", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "parent", "type": "string", "info": ": string", "required": false, "schema": { "title": "parent", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "parentN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTenancyTenantGroups" }, "task": true }, { "name": "postTenancyTenantGroups", "summary": "tenancy_tenant-groups_create", "description": "tenancy_tenant-groups_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"tenant_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTenancyTenantGroups" }, "task": true }, { "name": "putTenancyTenantGroups", "summary": "tenancy_tenant-groups_bulk_update", "description": "tenancy_tenant-groups_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"tenant_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyTenantGroups" }, "task": true }, { "name": "patchTenancyTenantGroups", "summary": "tenancy_tenant-groups_bulk_partial_update", "description": "tenancy_tenant-groups_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"tenant_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyTenantGroups" }, "task": true }, { "name": "deleteTenancyTenantGroups", "summary": "tenancy_tenant-groups_bulk_delete", "description": "tenancy_tenant-groups_bulk_delete", "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": "/deleteTenancyTenantGroups" }, "task": true }, { "name": "getTenancyTenantGroupsId", "summary": "tenancy_tenant-groups_read", "description": "tenancy_tenant-groups_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tenant group.: 123", "required": true, "schema": { "title": "id", "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": "/getTenancyTenantGroupsId" }, "task": true }, { "name": "putTenancyTenantGroupsId", "summary": "tenancy_tenant-groups_update", "description": "tenancy_tenant-groups_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tenant group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"tenant_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyTenantGroupsId" }, "task": true }, { "name": "patchTenancyTenantGroupsId", "summary": "tenancy_tenant-groups_partial_update", "description": "tenancy_tenant-groups_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tenant group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"tenant_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyTenantGroupsId" }, "task": true }, { "name": "deleteTenancyTenantGroupsId", "summary": "tenancy_tenant-groups_delete", "description": "tenancy_tenant-groups_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tenant group.: 123", "required": true, "schema": { "title": "id", "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": "/deleteTenancyTenantGroupsId" }, "task": true }, { "name": "getTenancyTenants", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "group", "type": "string", "info": ": string", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "group": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "tenant_count": { "title": "Tenant count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true }, "vrf_count": { "title": "Vrf count", "type": "integer", "readOnly": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTenancyTenants" }, "task": true }, { "name": "postTenancyTenants", "summary": "tenancy_tenants_create", "description": "tenancy_tenants_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"group\": 123, \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"ipaddress_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"site_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123, \"vrf_count\": 123, \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true }, "vrf_count": { "title": "Vrf count", "type": "integer", "readOnly": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTenancyTenants" }, "task": true }, { "name": "putTenancyTenants", "summary": "tenancy_tenants_bulk_update", "description": "tenancy_tenants_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"group\": 123, \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"ipaddress_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"site_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123, \"vrf_count\": 123, \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true }, "vrf_count": { "title": "Vrf count", "type": "integer", "readOnly": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyTenants" }, "task": true }, { "name": "patchTenancyTenants", "summary": "tenancy_tenants_bulk_partial_update", "description": "tenancy_tenants_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"group\": 123, \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"ipaddress_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"site_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123, \"vrf_count\": 123, \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true }, "vrf_count": { "title": "Vrf count", "type": "integer", "readOnly": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyTenants" }, "task": true }, { "name": "deleteTenancyTenants", "summary": "tenancy_tenants_bulk_delete", "description": "tenancy_tenants_bulk_delete", "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": "/deleteTenancyTenants" }, "task": true }, { "name": "getTenancyTenantsId", "summary": "tenancy_tenants_read", "description": "tenancy_tenants_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tenant.: 123", "required": true, "schema": { "title": "id", "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": "/getTenancyTenantsId" }, "task": true }, { "name": "putTenancyTenantsId", "summary": "tenancy_tenants_update", "description": "tenancy_tenants_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tenant.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"group\": 123, \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"ipaddress_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"site_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123, \"vrf_count\": 123, \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true }, "vrf_count": { "title": "Vrf count", "type": "integer", "readOnly": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTenancyTenantsId" }, "task": true }, { "name": "patchTenancyTenantsId", "summary": "tenancy_tenants_partial_update", "description": "tenancy_tenants_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tenant.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"group\": 123, \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"circuit_count\": 123, \"device_count\": 123, \"ipaddress_count\": 123, \"prefix_count\": 123, \"rack_count\": 123, \"site_count\": 123, \"virtualmachine_count\": 123, \"vlan_count\": 123, \"vrf_count\": 123, \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "circuit_count": { "title": "Circuit count", "type": "integer", "readOnly": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "ipaddress_count": { "title": "Ipaddress count", "type": "integer", "readOnly": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true }, "rack_count": { "title": "Rack count", "type": "integer", "readOnly": true }, "site_count": { "title": "Site count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true }, "vlan_count": { "title": "Vlan count", "type": "integer", "readOnly": true }, "vrf_count": { "title": "Vrf count", "type": "integer", "readOnly": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchTenancyTenantsId" }, "task": true }, { "name": "deleteTenancyTenantsId", "summary": "tenancy_tenants_delete", "description": "tenancy_tenants_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this tenant.: 123", "required": true, "schema": { "title": "id", "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": "/deleteTenancyTenantsId" }, "task": true }, { "name": "getUsersConfig", "summary": "Return the UserConfig for the currently authenticated User.", "description": "Return the UserConfig for the currently authenticated User.", "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": "/getUsersConfig" }, "task": true }, { "name": "getUsersGroups", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "nameEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameEmpty", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "user_count": { "title": "User count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersGroups" }, "task": true }, { "name": "postUsersGroups", "summary": "users_groups_create", "description": "users_groups_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"user_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "user_count": { "title": "User count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUsersGroups" }, "task": true }, { "name": "putUsersGroups", "summary": "users_groups_bulk_update", "description": "users_groups_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"user_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "user_count": { "title": "User count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersGroups" }, "task": true }, { "name": "patchUsersGroups", "summary": "users_groups_bulk_partial_update", "description": "users_groups_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"user_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "user_count": { "title": "User count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUsersGroups" }, "task": true }, { "name": "deleteUsersGroups", "summary": "users_groups_bulk_delete", "description": "users_groups_bulk_delete", "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": "/deleteUsersGroups" }, "task": true }, { "name": "getUsersGroupsId", "summary": "users_groups_read", "description": "users_groups_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this group.: 123", "required": true, "schema": { "title": "id", "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": "/getUsersGroupsId" }, "task": true }, { "name": "putUsersGroupsId", "summary": "users_groups_update", "description": "users_groups_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"user_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "user_count": { "title": "User count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersGroupsId" }, "task": true }, { "name": "patchUsersGroupsId", "summary": "users_groups_partial_update", "description": "users_groups_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"user_count\": 123}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 }, "user_count": { "title": "User count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUsersGroupsId" }, "task": true }, { "name": "deleteUsersGroupsId", "summary": "users_groups_delete", "description": "users_groups_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this group.: 123", "required": true, "schema": { "title": "id", "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": "/deleteUsersGroupsId" }, "task": true }, { "name": "getUsersPermissions", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "enabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "enabled", "type": "string" } }, { "name": "objectTypes", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectTypes", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "userId", "type": "string", "info": ": string", "required": false, "schema": { "title": "userId", "type": "string" } }, { "name": "user", "type": "string", "info": ": string", "required": false, "schema": { "title": "user", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "group", "type": "string", "info": ": string", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "nameEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameEmpty", "type": "string" } }, { "name": "objectTypesN", "type": "string", "info": ": string", "required": false, "schema": { "title": "objectTypesN", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "descriptionEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionEmpty", "type": "string" } }, { "name": "userIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userIdN", "type": "string" } }, { "name": "userN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userN", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "object_types", "actions" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "enabled": { "title": "Enabled", "type": "boolean" }, "object_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "groups": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 } } }, "uniqueItems": true }, "users": { "type": "array", "items": { "required": [ "username" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 } } }, "uniqueItems": true }, "actions": { "description": "The list of actions granted by this permission", "type": "array", "items": { "title": "Actions", "type": "string", "maxLength": 30, "minLength": 1 } }, "constraints": { "title": "Constraints", "description": "Queryset filter matching the applicable objects of the selected type(s)", "type": "object", "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersPermissions" }, "task": true }, { "name": "postUsersPermissions", "summary": "users_permissions_create", "description": "users_permissions_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"description\": \"string\", \"enabled\": \"boolean\", \"object_types\": \"array\", \"groups\": \"array\", \"users\": \"array\", \"actions\": \"array\", \"constraints\": \"object\"}", "required": true, "schema": { "required": [ "name", "object_types", "actions" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "enabled": { "title": "Enabled", "type": "boolean" }, "object_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "users": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "actions": { "description": "The list of actions granted by this permission", "type": "array", "items": { "title": "Actions", "type": "string", "maxLength": 30, "minLength": 1 } }, "constraints": { "title": "Constraints", "description": "Queryset filter matching the applicable objects of the selected type(s)", "type": "object", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUsersPermissions" }, "task": true }, { "name": "putUsersPermissions", "summary": "users_permissions_bulk_update", "description": "users_permissions_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"description\": \"string\", \"enabled\": \"boolean\", \"object_types\": \"array\", \"groups\": \"array\", \"users\": \"array\", \"actions\": \"array\", \"constraints\": \"object\"}", "required": true, "schema": { "required": [ "name", "object_types", "actions" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "enabled": { "title": "Enabled", "type": "boolean" }, "object_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "users": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "actions": { "description": "The list of actions granted by this permission", "type": "array", "items": { "title": "Actions", "type": "string", "maxLength": 30, "minLength": 1 } }, "constraints": { "title": "Constraints", "description": "Queryset filter matching the applicable objects of the selected type(s)", "type": "object", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersPermissions" }, "task": true }, { "name": "patchUsersPermissions", "summary": "users_permissions_bulk_partial_update", "description": "users_permissions_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"description\": \"string\", \"enabled\": \"boolean\", \"object_types\": \"array\", \"groups\": \"array\", \"users\": \"array\", \"actions\": \"array\", \"constraints\": \"object\"}", "required": true, "schema": { "required": [ "name", "object_types", "actions" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "enabled": { "title": "Enabled", "type": "boolean" }, "object_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "users": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "actions": { "description": "The list of actions granted by this permission", "type": "array", "items": { "title": "Actions", "type": "string", "maxLength": 30, "minLength": 1 } }, "constraints": { "title": "Constraints", "description": "Queryset filter matching the applicable objects of the selected type(s)", "type": "object", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUsersPermissions" }, "task": true }, { "name": "deleteUsersPermissions", "summary": "users_permissions_bulk_delete", "description": "users_permissions_bulk_delete", "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": "/deleteUsersPermissions" }, "task": true }, { "name": "getUsersPermissionsId", "summary": "users_permissions_read", "description": "users_permissions_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this permission.: 123", "required": true, "schema": { "title": "id", "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": "/getUsersPermissionsId" }, "task": true }, { "name": "putUsersPermissionsId", "summary": "users_permissions_update", "description": "users_permissions_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this permission.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"description\": \"string\", \"enabled\": \"boolean\", \"object_types\": \"array\", \"groups\": \"array\", \"users\": \"array\", \"actions\": \"array\", \"constraints\": \"object\"}", "required": true, "schema": { "required": [ "name", "object_types", "actions" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "enabled": { "title": "Enabled", "type": "boolean" }, "object_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "users": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "actions": { "description": "The list of actions granted by this permission", "type": "array", "items": { "title": "Actions", "type": "string", "maxLength": 30, "minLength": 1 } }, "constraints": { "title": "Constraints", "description": "Queryset filter matching the applicable objects of the selected type(s)", "type": "object", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersPermissionsId" }, "task": true }, { "name": "patchUsersPermissionsId", "summary": "users_permissions_partial_update", "description": "users_permissions_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this permission.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"description\": \"string\", \"enabled\": \"boolean\", \"object_types\": \"array\", \"groups\": \"array\", \"users\": \"array\", \"actions\": \"array\", \"constraints\": \"object\"}", "required": true, "schema": { "required": [ "name", "object_types", "actions" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "enabled": { "title": "Enabled", "type": "boolean" }, "object_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "groups": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "users": { "type": "array", "items": { "type": "integer" }, "uniqueItems": true }, "actions": { "description": "The list of actions granted by this permission", "type": "array", "items": { "title": "Actions", "type": "string", "maxLength": 30, "minLength": 1 } }, "constraints": { "title": "Constraints", "description": "Queryset filter matching the applicable objects of the selected type(s)", "type": "object", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUsersPermissionsId" }, "task": true }, { "name": "deleteUsersPermissionsId", "summary": "users_permissions_delete", "description": "users_permissions_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this permission.: 123", "required": true, "schema": { "title": "id", "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": "/deleteUsersPermissionsId" }, "task": true }, { "name": "getUsersTokens", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "key", "type": "string", "info": ": string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "writeEnabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "writeEnabled", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "userId", "type": "string", "info": ": string", "required": false, "schema": { "title": "userId", "type": "string" } }, { "name": "user", "type": "string", "info": ": string", "required": false, "schema": { "title": "user", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "expires", "type": "string", "info": ": string", "required": false, "schema": { "title": "expires", "type": "string" } }, { "name": "expiresGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "expiresGte", "type": "string" } }, { "name": "expiresLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "expiresLte", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "keyN", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyN", "type": "string" } }, { "name": "keyIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyIc", "type": "string" } }, { "name": "keyNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyNic", "type": "string" } }, { "name": "keyIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyIew", "type": "string" } }, { "name": "keyNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyNiew", "type": "string" } }, { "name": "keyIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyIsw", "type": "string" } }, { "name": "keyNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyNisw", "type": "string" } }, { "name": "keyIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyIe", "type": "string" } }, { "name": "keyNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyNie", "type": "string" } }, { "name": "keyEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "keyEmpty", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "descriptionEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionEmpty", "type": "string" } }, { "name": "userIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userIdN", "type": "string" } }, { "name": "userN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "user" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "user": { "required": [ "username" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 } } }, "created": { "title": "Created", "type": "string", "readOnly": true }, "expires": { "title": "Expires", "type": "string", "x-nullable": true }, "last_used": { "title": "Last used", "type": "string", "x-nullable": true }, "key": { "title": "Key", "type": "string", "maxLength": 40, "minLength": 40 }, "write_enabled": { "title": "Write enabled", "description": "Permit create/update/delete operations using this key", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "allowed_ips": { "type": "array", "items": { "type": "object", "properties": {} }, "default": [] } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersTokens" }, "task": true }, { "name": "postUsersTokens", "summary": "users_tokens_create", "description": "users_tokens_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"user\": 123, \"created\": \"string\", \"expires\": \"string\", \"last_used\": \"string\", \"key\": \"string\", \"write_enabled\": \"boolean\", \"description\": \"string\", \"allowed_ips\": [}]}", "required": true, "schema": { "required": [ "user" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "user": { "title": "User", "type": "integer" }, "created": { "title": "Created", "type": "string", "readOnly": true }, "expires": { "title": "Expires", "type": "string", "x-nullable": true }, "last_used": { "title": "Last used", "type": "string", "x-nullable": true }, "key": { "title": "Key", "type": "string", "maxLength": 40, "minLength": 40 }, "write_enabled": { "title": "Write enabled", "description": "Permit create/update/delete operations using this key", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "allowed_ips": { "type": "array", "items": { "type": "object", "properties": {} }, "default": [] } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUsersTokens" }, "task": true }, { "name": "putUsersTokens", "summary": "users_tokens_bulk_update", "description": "users_tokens_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"user\": 123, \"created\": \"string\", \"expires\": \"string\", \"last_used\": \"string\", \"key\": \"string\", \"write_enabled\": \"boolean\", \"description\": \"string\", \"allowed_ips\": [}]}", "required": true, "schema": { "required": [ "user" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "user": { "title": "User", "type": "integer" }, "created": { "title": "Created", "type": "string", "readOnly": true }, "expires": { "title": "Expires", "type": "string", "x-nullable": true }, "last_used": { "title": "Last used", "type": "string", "x-nullable": true }, "key": { "title": "Key", "type": "string", "maxLength": 40, "minLength": 40 }, "write_enabled": { "title": "Write enabled", "description": "Permit create/update/delete operations using this key", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "allowed_ips": { "type": "array", "items": { "type": "object", "properties": {} }, "default": [] } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersTokens" }, "task": true }, { "name": "patchUsersTokens", "summary": "users_tokens_bulk_partial_update", "description": "users_tokens_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"user\": 123, \"created\": \"string\", \"expires\": \"string\", \"last_used\": \"string\", \"key\": \"string\", \"write_enabled\": \"boolean\", \"description\": \"string\", \"allowed_ips\": [}]}", "required": true, "schema": { "required": [ "user" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "user": { "title": "User", "type": "integer" }, "created": { "title": "Created", "type": "string", "readOnly": true }, "expires": { "title": "Expires", "type": "string", "x-nullable": true }, "last_used": { "title": "Last used", "type": "string", "x-nullable": true }, "key": { "title": "Key", "type": "string", "maxLength": 40, "minLength": 40 }, "write_enabled": { "title": "Write enabled", "description": "Permit create/update/delete operations using this key", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "allowed_ips": { "type": "array", "items": { "type": "object", "properties": {} }, "default": [] } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUsersTokens" }, "task": true }, { "name": "deleteUsersTokens", "summary": "users_tokens_bulk_delete", "description": "users_tokens_bulk_delete", "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": "/deleteUsersTokens" }, "task": true }, { "name": "postUsersTokensProvision", "summary": "Non-authenticated REST API endpoint via which a user may create a Token.", "description": "Non-authenticated REST API endpoint via which a user may create a Token.", "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": "/postUsersTokensProvision" }, "task": true }, { "name": "getUsersTokensId", "summary": "users_tokens_read", "description": "users_tokens_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this token.: 123", "required": true, "schema": { "title": "id", "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": "/getUsersTokensId" }, "task": true }, { "name": "putUsersTokensId", "summary": "users_tokens_update", "description": "users_tokens_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this token.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"user\": 123, \"created\": \"string\", \"expires\": \"string\", \"last_used\": \"string\", \"key\": \"string\", \"write_enabled\": \"boolean\", \"description\": \"string\", \"allowed_ips\": [}]}", "required": true, "schema": { "required": [ "user" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "user": { "title": "User", "type": "integer" }, "created": { "title": "Created", "type": "string", "readOnly": true }, "expires": { "title": "Expires", "type": "string", "x-nullable": true }, "last_used": { "title": "Last used", "type": "string", "x-nullable": true }, "key": { "title": "Key", "type": "string", "maxLength": 40, "minLength": 40 }, "write_enabled": { "title": "Write enabled", "description": "Permit create/update/delete operations using this key", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "allowed_ips": { "type": "array", "items": { "type": "object", "properties": {} }, "default": [] } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersTokensId" }, "task": true }, { "name": "patchUsersTokensId", "summary": "users_tokens_partial_update", "description": "users_tokens_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this token.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"user\": 123, \"created\": \"string\", \"expires\": \"string\", \"last_used\": \"string\", \"key\": \"string\", \"write_enabled\": \"boolean\", \"description\": \"string\", \"allowed_ips\": [}]}", "required": true, "schema": { "required": [ "user" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "user": { "title": "User", "type": "integer" }, "created": { "title": "Created", "type": "string", "readOnly": true }, "expires": { "title": "Expires", "type": "string", "x-nullable": true }, "last_used": { "title": "Last used", "type": "string", "x-nullable": true }, "key": { "title": "Key", "type": "string", "maxLength": 40, "minLength": 40 }, "write_enabled": { "title": "Write enabled", "description": "Permit create/update/delete operations using this key", "type": "boolean" }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "allowed_ips": { "type": "array", "items": { "type": "object", "properties": {} }, "default": [] } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUsersTokensId" }, "task": true }, { "name": "deleteUsersTokensId", "summary": "users_tokens_delete", "description": "users_tokens_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this token.: 123", "required": true, "schema": { "title": "id", "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": "/deleteUsersTokensId" }, "task": true }, { "name": "getUsersUsers", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "username", "type": "string", "info": ": string", "required": false, "schema": { "title": "username", "type": "string" } }, { "name": "firstName", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstName", "type": "string" } }, { "name": "lastName", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastName", "type": "string" } }, { "name": "email", "type": "string", "info": ": string", "required": false, "schema": { "title": "email", "type": "string" } }, { "name": "isStaff", "type": "string", "info": ": string", "required": false, "schema": { "title": "isStaff", "type": "string" } }, { "name": "isActive", "type": "string", "info": ": string", "required": false, "schema": { "title": "isActive", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "group", "type": "string", "info": ": string", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "usernameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameN", "type": "string" } }, { "name": "usernameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameIc", "type": "string" } }, { "name": "usernameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameNic", "type": "string" } }, { "name": "usernameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameIew", "type": "string" } }, { "name": "usernameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameNiew", "type": "string" } }, { "name": "usernameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameIsw", "type": "string" } }, { "name": "usernameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameNisw", "type": "string" } }, { "name": "usernameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameIe", "type": "string" } }, { "name": "usernameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameNie", "type": "string" } }, { "name": "usernameEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "usernameEmpty", "type": "string" } }, { "name": "firstNameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameN", "type": "string" } }, { "name": "firstNameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameIc", "type": "string" } }, { "name": "firstNameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameNic", "type": "string" } }, { "name": "firstNameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameIew", "type": "string" } }, { "name": "firstNameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameNiew", "type": "string" } }, { "name": "firstNameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameIsw", "type": "string" } }, { "name": "firstNameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameNisw", "type": "string" } }, { "name": "firstNameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameIe", "type": "string" } }, { "name": "firstNameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameNie", "type": "string" } }, { "name": "firstNameEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "firstNameEmpty", "type": "string" } }, { "name": "lastNameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameN", "type": "string" } }, { "name": "lastNameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameIc", "type": "string" } }, { "name": "lastNameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameNic", "type": "string" } }, { "name": "lastNameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameIew", "type": "string" } }, { "name": "lastNameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameNiew", "type": "string" } }, { "name": "lastNameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameIsw", "type": "string" } }, { "name": "lastNameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameNisw", "type": "string" } }, { "name": "lastNameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameIe", "type": "string" } }, { "name": "lastNameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameNie", "type": "string" } }, { "name": "lastNameEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastNameEmpty", "type": "string" } }, { "name": "emailN", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailN", "type": "string" } }, { "name": "emailIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailIc", "type": "string" } }, { "name": "emailNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailNic", "type": "string" } }, { "name": "emailIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailIew", "type": "string" } }, { "name": "emailNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailNiew", "type": "string" } }, { "name": "emailIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailIsw", "type": "string" } }, { "name": "emailNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailNisw", "type": "string" } }, { "name": "emailIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailIe", "type": "string" } }, { "name": "emailNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailNie", "type": "string" } }, { "name": "emailEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "emailEmpty", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "username", "password" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 }, "password": { "title": "Password", "type": "string", "maxLength": 128, "minLength": 1 }, "first_name": { "title": "First name", "type": "string", "maxLength": 150 }, "last_name": { "title": "Last name", "type": "string", "maxLength": 150 }, "email": { "title": "Email address", "type": "string", "maxLength": 254 }, "is_staff": { "title": "Staff status", "description": "Designates whether the user can log into this admin site.", "type": "boolean" }, "is_active": { "title": "Active", "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.", "type": "boolean" }, "date_joined": { "title": "Date joined", "type": "string" }, "groups": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 150, "minLength": 1 } } }, "uniqueItems": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsers" }, "task": true }, { "name": "postUsersUsers", "summary": "users_users_create", "description": "users_users_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"username\": \"string\", \"password\": \"string\", \"first_name\": \"string\", \"last_name\": \"string\", \"email\": \"string\", \"is_staff\": \"boolean\", \"is_active\": \"boolean\", \"date_joined\": \"string\", \"groups\": \"array\"}", "required": true, "schema": { "required": [ "username", "password" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 }, "password": { "title": "Password", "type": "string", "maxLength": 128, "minLength": 1 }, "first_name": { "title": "First name", "type": "string", "maxLength": 150 }, "last_name": { "title": "Last name", "type": "string", "maxLength": 150 }, "email": { "title": "Email address", "type": "string", "maxLength": 254 }, "is_staff": { "title": "Staff status", "description": "Designates whether the user can log into this admin site.", "type": "boolean" }, "is_active": { "title": "Active", "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.", "type": "boolean" }, "date_joined": { "title": "Date joined", "type": "string" }, "groups": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "array", "items": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "integer" }, "uniqueItems": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUsersUsers" }, "task": true }, { "name": "putUsersUsers", "summary": "users_users_bulk_update", "description": "users_users_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"username\": \"string\", \"password\": \"string\", \"first_name\": \"string\", \"last_name\": \"string\", \"email\": \"string\", \"is_staff\": \"boolean\", \"is_active\": \"boolean\", \"date_joined\": \"string\", \"groups\": \"array\"}", "required": true, "schema": { "required": [ "username", "password" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 }, "password": { "title": "Password", "type": "string", "maxLength": 128, "minLength": 1 }, "first_name": { "title": "First name", "type": "string", "maxLength": 150 }, "last_name": { "title": "Last name", "type": "string", "maxLength": 150 }, "email": { "title": "Email address", "type": "string", "maxLength": 254 }, "is_staff": { "title": "Staff status", "description": "Designates whether the user can log into this admin site.", "type": "boolean" }, "is_active": { "title": "Active", "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.", "type": "boolean" }, "date_joined": { "title": "Date joined", "type": "string" }, "groups": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "array", "items": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "integer" }, "uniqueItems": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersUsers" }, "task": true }, { "name": "patchUsersUsers", "summary": "users_users_bulk_partial_update", "description": "users_users_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"username\": \"string\", \"password\": \"string\", \"first_name\": \"string\", \"last_name\": \"string\", \"email\": \"string\", \"is_staff\": \"boolean\", \"is_active\": \"boolean\", \"date_joined\": \"string\", \"groups\": \"array\"}", "required": true, "schema": { "required": [ "username", "password" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 }, "password": { "title": "Password", "type": "string", "maxLength": 128, "minLength": 1 }, "first_name": { "title": "First name", "type": "string", "maxLength": 150 }, "last_name": { "title": "Last name", "type": "string", "maxLength": 150 }, "email": { "title": "Email address", "type": "string", "maxLength": 254 }, "is_staff": { "title": "Staff status", "description": "Designates whether the user can log into this admin site.", "type": "boolean" }, "is_active": { "title": "Active", "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.", "type": "boolean" }, "date_joined": { "title": "Date joined", "type": "string" }, "groups": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "array", "items": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "integer" }, "uniqueItems": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUsersUsers" }, "task": true }, { "name": "deleteUsersUsers", "summary": "users_users_bulk_delete", "description": "users_users_bulk_delete", "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": "/deleteUsersUsers" }, "task": true }, { "name": "getUsersUsersId", "summary": "users_users_read", "description": "users_users_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this user.: 123", "required": true, "schema": { "title": "id", "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": "/getUsersUsersId" }, "task": true }, { "name": "putUsersUsersId", "summary": "users_users_update", "description": "users_users_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this user.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"username\": \"string\", \"password\": \"string\", \"first_name\": \"string\", \"last_name\": \"string\", \"email\": \"string\", \"is_staff\": \"boolean\", \"is_active\": \"boolean\", \"date_joined\": \"string\", \"groups\": \"array\"}", "required": true, "schema": { "required": [ "username", "password" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 }, "password": { "title": "Password", "type": "string", "maxLength": 128, "minLength": 1 }, "first_name": { "title": "First name", "type": "string", "maxLength": 150 }, "last_name": { "title": "Last name", "type": "string", "maxLength": 150 }, "email": { "title": "Email address", "type": "string", "maxLength": 254 }, "is_staff": { "title": "Staff status", "description": "Designates whether the user can log into this admin site.", "type": "boolean" }, "is_active": { "title": "Active", "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.", "type": "boolean" }, "date_joined": { "title": "Date joined", "type": "string" }, "groups": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "array", "items": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "integer" }, "uniqueItems": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersUsersId" }, "task": true }, { "name": "patchUsersUsersId", "summary": "users_users_partial_update", "description": "users_users_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this user.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"username\": \"string\", \"password\": \"string\", \"first_name\": \"string\", \"last_name\": \"string\", \"email\": \"string\", \"is_staff\": \"boolean\", \"is_active\": \"boolean\", \"date_joined\": \"string\", \"groups\": \"array\"}", "required": true, "schema": { "required": [ "username", "password" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 }, "password": { "title": "Password", "type": "string", "maxLength": 128, "minLength": 1 }, "first_name": { "title": "First name", "type": "string", "maxLength": 150 }, "last_name": { "title": "Last name", "type": "string", "maxLength": 150 }, "email": { "title": "Email address", "type": "string", "maxLength": 254 }, "is_staff": { "title": "Staff status", "description": "Designates whether the user can log into this admin site.", "type": "boolean" }, "is_active": { "title": "Active", "description": "Designates whether this user should be treated as active. Unselect this instead of deleting accounts.", "type": "boolean" }, "date_joined": { "title": "Date joined", "type": "string" }, "groups": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "array", "items": { "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups.", "type": "integer" }, "uniqueItems": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchUsersUsersId" }, "task": true }, { "name": "deleteUsersUsersId", "summary": "users_users_delete", "description": "users_users_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this user.: 123", "required": true, "schema": { "title": "id", "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": "/deleteUsersUsersId" }, "task": true }, { "name": "getVirtualizationClusterGroups", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVirtualizationClusterGroups" }, "task": true }, { "name": "postVirtualizationClusterGroups", "summary": "virtualization_cluster-groups_create", "description": "virtualization_cluster-groups_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualizationClusterGroups" }, "task": true }, { "name": "putVirtualizationClusterGroups", "summary": "virtualization_cluster-groups_bulk_update", "description": "virtualization_cluster-groups_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationClusterGroups" }, "task": true }, { "name": "patchVirtualizationClusterGroups", "summary": "virtualization_cluster-groups_bulk_partial_update", "description": "virtualization_cluster-groups_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationClusterGroups" }, "task": true }, { "name": "deleteVirtualizationClusterGroups", "summary": "virtualization_cluster-groups_bulk_delete", "description": "virtualization_cluster-groups_bulk_delete", "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": "/deleteVirtualizationClusterGroups" }, "task": true }, { "name": "getVirtualizationClusterGroupsId", "summary": "virtualization_cluster-groups_read", "description": "virtualization_cluster-groups_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster group.: 123", "required": true, "schema": { "title": "id", "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": "/getVirtualizationClusterGroupsId" }, "task": true }, { "name": "putVirtualizationClusterGroupsId", "summary": "virtualization_cluster-groups_update", "description": "virtualization_cluster-groups_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationClusterGroupsId" }, "task": true }, { "name": "patchVirtualizationClusterGroupsId", "summary": "virtualization_cluster-groups_partial_update", "description": "virtualization_cluster-groups_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationClusterGroupsId" }, "task": true }, { "name": "deleteVirtualizationClusterGroupsId", "summary": "virtualization_cluster-groups_delete", "description": "virtualization_cluster-groups_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster group.: 123", "required": true, "schema": { "title": "id", "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": "/deleteVirtualizationClusterGroupsId" }, "task": true }, { "name": "getVirtualizationClusterTypes", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVirtualizationClusterTypes" }, "task": true }, { "name": "postVirtualizationClusterTypes", "summary": "virtualization_cluster-types_create", "description": "virtualization_cluster-types_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualizationClusterTypes" }, "task": true }, { "name": "putVirtualizationClusterTypes", "summary": "virtualization_cluster-types_bulk_update", "description": "virtualization_cluster-types_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationClusterTypes" }, "task": true }, { "name": "patchVirtualizationClusterTypes", "summary": "virtualization_cluster-types_bulk_partial_update", "description": "virtualization_cluster-types_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationClusterTypes" }, "task": true }, { "name": "deleteVirtualizationClusterTypes", "summary": "virtualization_cluster-types_bulk_delete", "description": "virtualization_cluster-types_bulk_delete", "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": "/deleteVirtualizationClusterTypes" }, "task": true }, { "name": "getVirtualizationClusterTypesId", "summary": "virtualization_cluster-types_read", "description": "virtualization_cluster-types_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster type.: 123", "required": true, "schema": { "title": "id", "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": "/getVirtualizationClusterTypesId" }, "task": true }, { "name": "putVirtualizationClusterTypesId", "summary": "virtualization_cluster-types_update", "description": "virtualization_cluster-types_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster type.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationClusterTypesId" }, "task": true }, { "name": "patchVirtualizationClusterTypesId", "summary": "virtualization_cluster-types_partial_update", "description": "virtualization_cluster-types_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster type.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"cluster_count\": 123}", "required": true, "schema": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationClusterTypesId" }, "task": true }, { "name": "deleteVirtualizationClusterTypesId", "summary": "virtualization_cluster-types_delete", "description": "virtualization_cluster-types_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster type.: 123", "required": true, "schema": { "title": "id", "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": "/deleteVirtualizationClusterTypesId" }, "task": true }, { "name": "getVirtualizationClusters", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "group", "type": "string", "info": ": string", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "typeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeId", "type": "string" } }, { "name": "type", "type": "string", "info": ": string", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupN", "type": "string" } }, { "name": "typeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeIdN", "type": "string" } }, { "name": "typeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "typeN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "type": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } } }, "group": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "cluster_count": { "title": "Cluster count", "type": "integer", "readOnly": true } } }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Planned", "Staging", "Active", "Decommissioning", "Offline" ] }, "value": { "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "offline" ] } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVirtualizationClusters" }, "task": true }, { "name": "postVirtualizationClusters", "summary": "virtualization_clusters_create", "description": "virtualization_clusters_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"type\": 123, \"group\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, offline]\", \"tenant\": 123, \"site\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "type", "group", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "integer" }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "offline" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualizationClusters" }, "task": true }, { "name": "putVirtualizationClusters", "summary": "virtualization_clusters_bulk_update", "description": "virtualization_clusters_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"type\": 123, \"group\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, offline]\", \"tenant\": 123, \"site\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "type", "group", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "integer" }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "offline" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationClusters" }, "task": true }, { "name": "patchVirtualizationClusters", "summary": "virtualization_clusters_bulk_partial_update", "description": "virtualization_clusters_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"type\": 123, \"group\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, offline]\", \"tenant\": 123, \"site\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "type", "group", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "integer" }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "offline" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationClusters" }, "task": true }, { "name": "deleteVirtualizationClusters", "summary": "virtualization_clusters_bulk_delete", "description": "virtualization_clusters_bulk_delete", "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": "/deleteVirtualizationClusters" }, "task": true }, { "name": "getVirtualizationClustersId", "summary": "virtualization_clusters_read", "description": "virtualization_clusters_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster.: 123", "required": true, "schema": { "title": "id", "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": "/getVirtualizationClustersId" }, "task": true }, { "name": "putVirtualizationClustersId", "summary": "virtualization_clusters_update", "description": "virtualization_clusters_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"type\": 123, \"group\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, offline]\", \"tenant\": 123, \"site\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "type", "group", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "integer" }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "offline" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationClustersId" }, "task": true }, { "name": "patchVirtualizationClustersId", "summary": "virtualization_clusters_partial_update", "description": "virtualization_clusters_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"type\": 123, \"group\": 123, \"status\": \"Must be one of [planned, staging, active, decommissioning, offline]\", \"tenant\": 123, \"site\": 123, \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"device_count\": 123, \"virtualmachine_count\": 123}", "required": true, "schema": { "required": [ "name", "type", "group", "site" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "integer" }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "planned", "staging", "active", "decommissioning", "offline" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationClustersId" }, "task": true }, { "name": "deleteVirtualizationClustersId", "summary": "virtualization_clusters_delete", "description": "virtualization_clusters_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this cluster.: 123", "required": true, "schema": { "title": "id", "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": "/deleteVirtualizationClustersId" }, "task": true }, { "name": "getVirtualizationInterfaces", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "enabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "enabled", "type": "string" } }, { "name": "mtu", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtu", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "clusterId", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterId", "type": "string" } }, { "name": "cluster", "type": "string", "info": ": string", "required": false, "schema": { "title": "cluster", "type": "string" } }, { "name": "virtualMachineId", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineId", "type": "string" } }, { "name": "virtualMachine", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachine", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "bridgeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "bridgeId", "type": "string" } }, { "name": "macAddress", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddress", "type": "string" } }, { "name": "vrfId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfId", "type": "string" } }, { "name": "vrf", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrf", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "mtuN", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuN", "type": "string" } }, { "name": "mtuLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuLte", "type": "string" } }, { "name": "mtuLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuLt", "type": "string" } }, { "name": "mtuGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuGte", "type": "string" } }, { "name": "mtuGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "mtuGt", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "clusterIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterIdN", "type": "string" } }, { "name": "clusterN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterN", "type": "string" } }, { "name": "virtualMachineIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineIdN", "type": "string" } }, { "name": "virtualMachineN", "type": "string", "info": ": string", "required": false, "schema": { "title": "virtualMachineN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "bridgeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "bridgeIdN", "type": "string" } }, { "name": "macAddressN", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressN", "type": "string" } }, { "name": "macAddressIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIc", "type": "string" } }, { "name": "macAddressNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNic", "type": "string" } }, { "name": "macAddressIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIew", "type": "string" } }, { "name": "macAddressNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNiew", "type": "string" } }, { "name": "macAddressIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIsw", "type": "string" } }, { "name": "macAddressNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNisw", "type": "string" } }, { "name": "macAddressIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIe", "type": "string" } }, { "name": "macAddressNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNie", "type": "string" } }, { "name": "vrfIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfIdN", "type": "string" } }, { "name": "vrfN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vrfN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "virtual_machine", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "virtual_machine": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "virtual_machine": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "bridge": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "virtual_machine": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Access", "Tagged", "Tagged (All)" ] }, "value": { "type": "string", "enum": [ "access", "tagged", "tagged-all" ] } } }, "untagged_vlan": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "uniqueItems": true }, "vrf": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "rd": { "title": "Route distinguisher", "description": "Unique route distinguisher (as defined in RFC 4364)", "type": "string", "maxLength": 21, "x-nullable": true }, "prefix_count": { "title": "Prefix count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "l2vpn_termination": { "required": [ "l2vpn" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "l2vpn": { "required": [ "name", "slug", "type" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "identifier": { "title": "Identifier", "type": "integer", "maximum": 9223372036854776000, "minimum": -9223372036854776000, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "type": { "title": "Type", "type": "string", "enum": [ "vpws", "vpls", "vxlan", "vxlan-evpn", "mpls-evpn", "pbb-evpn", "epl", "evpl", "ep-lan", "evp-lan", "ep-tree", "evp-tree" ] } } } } }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVirtualizationInterfaces" }, "task": true }, { "name": "postVirtualizationInterfaces", "summary": "virtualization_interfaces_create", "description": "virtualization_interfaces_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"virtual_machine\": 123, \"name\": \"string\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123}", "required": true, "schema": { "required": [ "virtual_machine", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualizationInterfaces" }, "task": true }, { "name": "putVirtualizationInterfaces", "summary": "virtualization_interfaces_bulk_update", "description": "virtualization_interfaces_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"virtual_machine\": 123, \"name\": \"string\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123}", "required": true, "schema": { "required": [ "virtual_machine", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationInterfaces" }, "task": true }, { "name": "patchVirtualizationInterfaces", "summary": "virtualization_interfaces_bulk_partial_update", "description": "virtualization_interfaces_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"virtual_machine\": 123, \"name\": \"string\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123}", "required": true, "schema": { "required": [ "virtual_machine", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationInterfaces" }, "task": true }, { "name": "deleteVirtualizationInterfaces", "summary": "virtualization_interfaces_bulk_delete", "description": "virtualization_interfaces_bulk_delete", "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": "/deleteVirtualizationInterfaces" }, "task": true }, { "name": "getVirtualizationInterfacesId", "summary": "virtualization_interfaces_read", "description": "virtualization_interfaces_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "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": "/getVirtualizationInterfacesId" }, "task": true }, { "name": "putVirtualizationInterfacesId", "summary": "virtualization_interfaces_update", "description": "virtualization_interfaces_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"virtual_machine\": 123, \"name\": \"string\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123}", "required": true, "schema": { "required": [ "virtual_machine", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationInterfacesId" }, "task": true }, { "name": "patchVirtualizationInterfacesId", "summary": "virtualization_interfaces_partial_update", "description": "virtualization_interfaces_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"virtual_machine\": 123, \"name\": \"string\", \"enabled\": \"boolean\", \"parent\": 123, \"bridge\": 123, \"mtu\": 123, \"mac_address\": \"string\", \"description\": \"string\", \"mode\": \"Must be one of [access, tagged, tagged-all]\", \"untagged_vlan\": 123, \"tagged_vlans\": \"array\", \"vrf\": 123, \"l2vpn_termination\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"count_ipaddresses\": 123, \"count_fhrp_groups\": 123}", "required": true, "schema": { "required": [ "virtual_machine", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "virtual_machine": { "title": "Virtual machine", "type": "integer" }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "enabled": { "title": "Enabled", "type": "boolean" }, "parent": { "title": "Parent interface", "type": "integer", "x-nullable": true }, "bridge": { "title": "Bridge interface", "type": "integer", "x-nullable": true }, "mtu": { "title": "MTU", "type": "integer", "maximum": 65536, "minimum": 1, "x-nullable": true }, "mac_address": { "title": "MAC Address", "type": "string", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "mode": { "title": "Mode", "type": "string", "enum": [ "access", "tagged", "tagged-all" ] }, "untagged_vlan": { "title": "Untagged VLAN", "type": "integer", "x-nullable": true }, "tagged_vlans": { "type": "array", "items": { "title": "Tagged VLANs", "type": "integer" }, "uniqueItems": true }, "vrf": { "title": "VRF", "type": "integer", "x-nullable": true }, "l2vpn_termination": { "title": "L2vpn termination", "type": "string", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "count_ipaddresses": { "title": "Count ipaddresses", "type": "integer", "readOnly": true }, "count_fhrp_groups": { "title": "Count fhrp groups", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationInterfacesId" }, "task": true }, { "name": "deleteVirtualizationInterfacesId", "summary": "virtualization_interfaces_delete", "description": "virtualization_interfaces_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this interface.: 123", "required": true, "schema": { "title": "id", "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": "/deleteVirtualizationInterfacesId" }, "task": true }, { "name": "getVirtualizationVirtualMachines", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "cluster", "type": "string", "info": ": string", "required": false, "schema": { "title": "cluster", "type": "string" } }, { "name": "vcpus", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcpus", "type": "string" } }, { "name": "memory", "type": "string", "info": ": string", "required": false, "schema": { "title": "memory", "type": "string" } }, { "name": "disk", "type": "string", "info": ": string", "required": false, "schema": { "title": "disk", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "contact", "type": "string", "info": ": string", "required": false, "schema": { "title": "contact", "type": "string" } }, { "name": "contactRole", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRole", "type": "string" } }, { "name": "contactGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroup", "type": "string" } }, { "name": "localContextData", "type": "string", "info": ": string", "required": false, "schema": { "title": "localContextData", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "clusterGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterGroupId", "type": "string" } }, { "name": "clusterGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterGroup", "type": "string" } }, { "name": "clusterTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterTypeId", "type": "string" } }, { "name": "clusterType", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterType", "type": "string" } }, { "name": "clusterId", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterId", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "regionId", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionId", "type": "string" } }, { "name": "region", "type": "string", "info": ": string", "required": false, "schema": { "title": "region", "type": "string" } }, { "name": "siteGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupId", "type": "string" } }, { "name": "siteGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroup", "type": "string" } }, { "name": "siteId", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteId", "type": "string" } }, { "name": "site", "type": "string", "info": ": string", "required": false, "schema": { "title": "site", "type": "string" } }, { "name": "roleId", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleId", "type": "string" } }, { "name": "role", "type": "string", "info": ": string", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "platformId", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformId", "type": "string" } }, { "name": "platform", "type": "string", "info": ": string", "required": false, "schema": { "title": "platform", "type": "string" } }, { "name": "macAddress", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddress", "type": "string" } }, { "name": "hasPrimaryIp", "type": "string", "info": ": string", "required": false, "schema": { "title": "hasPrimaryIp", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "clusterN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterN", "type": "string" } }, { "name": "vcpusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcpusN", "type": "string" } }, { "name": "vcpusLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcpusLte", "type": "string" } }, { "name": "vcpusLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcpusLt", "type": "string" } }, { "name": "vcpusGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcpusGte", "type": "string" } }, { "name": "vcpusGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "vcpusGt", "type": "string" } }, { "name": "memoryN", "type": "string", "info": ": string", "required": false, "schema": { "title": "memoryN", "type": "string" } }, { "name": "memoryLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "memoryLte", "type": "string" } }, { "name": "memoryLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "memoryLt", "type": "string" } }, { "name": "memoryGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "memoryGte", "type": "string" } }, { "name": "memoryGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "memoryGt", "type": "string" } }, { "name": "diskN", "type": "string", "info": ": string", "required": false, "schema": { "title": "diskN", "type": "string" } }, { "name": "diskLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "diskLte", "type": "string" } }, { "name": "diskLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "diskLt", "type": "string" } }, { "name": "diskGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "diskGte", "type": "string" } }, { "name": "diskGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "diskGt", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "contactN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactN", "type": "string" } }, { "name": "contactRoleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactRoleN", "type": "string" } }, { "name": "contactGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contactGroupN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "clusterGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterGroupIdN", "type": "string" } }, { "name": "clusterGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterGroupN", "type": "string" } }, { "name": "clusterTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterTypeIdN", "type": "string" } }, { "name": "clusterTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterTypeN", "type": "string" } }, { "name": "clusterIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "clusterIdN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "regionIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionIdN", "type": "string" } }, { "name": "regionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "regionN", "type": "string" } }, { "name": "siteGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupIdN", "type": "string" } }, { "name": "siteGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteGroupN", "type": "string" } }, { "name": "siteIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteIdN", "type": "string" } }, { "name": "siteN", "type": "string", "info": ": string", "required": false, "schema": { "title": "siteN", "type": "string" } }, { "name": "roleIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleIdN", "type": "string" } }, { "name": "roleN", "type": "string", "info": ": string", "required": false, "schema": { "title": "roleN", "type": "string" } }, { "name": "platformIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformIdN", "type": "string" } }, { "name": "platformN", "type": "string", "info": ": string", "required": false, "schema": { "title": "platformN", "type": "string" } }, { "name": "macAddressN", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressN", "type": "string" } }, { "name": "macAddressIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIc", "type": "string" } }, { "name": "macAddressNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNic", "type": "string" } }, { "name": "macAddressIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIew", "type": "string" } }, { "name": "macAddressNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNiew", "type": "string" } }, { "name": "macAddressIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIsw", "type": "string" } }, { "name": "macAddressNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNisw", "type": "string" } }, { "name": "macAddressIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressIe", "type": "string" } }, { "name": "macAddressNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "macAddressNie", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Offline", "Active", "Planned", "Staged", "Failed", "Decommissioning" ] }, "value": { "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "decommissioning" ] } } }, "site": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "cluster": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "role": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "platform": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "device_count": { "title": "Device count", "type": "integer", "readOnly": true }, "virtualmachine_count": { "title": "Virtualmachine count", "type": "integer", "readOnly": true } }, "x-nullable": true }, "primary_ip": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "primary_ip4": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "primary_ip6": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "vcpus": { "title": "VCPUs", "type": "number", "minimum": 0.01, "x-nullable": true }, "memory": { "title": "Memory (MB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "disk": { "title": "Disk (GB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVirtualizationVirtualMachines" }, "task": true }, { "name": "postVirtualizationVirtualMachines", "summary": "virtualization_virtual-machines_create", "description": "virtualization_virtual-machines_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, staged, failed, decommissioning]\", \"site\": 123, \"cluster\": 123, \"device\": 123, \"role\": 123, \"tenant\": 123, \"platform\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"vcpus\": 123, \"memory\": 123, \"disk\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "decommissioning" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "vcpus": { "title": "VCPUs", "type": "number", "minimum": 0.01, "x-nullable": true }, "memory": { "title": "Memory (MB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "disk": { "title": "Disk (GB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualizationVirtualMachines" }, "task": true }, { "name": "putVirtualizationVirtualMachines", "summary": "virtualization_virtual-machines_bulk_update", "description": "virtualization_virtual-machines_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, staged, failed, decommissioning]\", \"site\": 123, \"cluster\": 123, \"device\": 123, \"role\": 123, \"tenant\": 123, \"platform\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"vcpus\": 123, \"memory\": 123, \"disk\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "decommissioning" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "vcpus": { "title": "VCPUs", "type": "number", "minimum": 0.01, "x-nullable": true }, "memory": { "title": "Memory (MB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "disk": { "title": "Disk (GB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationVirtualMachines" }, "task": true }, { "name": "patchVirtualizationVirtualMachines", "summary": "virtualization_virtual-machines_bulk_partial_update", "description": "virtualization_virtual-machines_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, staged, failed, decommissioning]\", \"site\": 123, \"cluster\": 123, \"device\": 123, \"role\": 123, \"tenant\": 123, \"platform\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"vcpus\": 123, \"memory\": 123, \"disk\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "decommissioning" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "vcpus": { "title": "VCPUs", "type": "number", "minimum": 0.01, "x-nullable": true }, "memory": { "title": "Memory (MB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "disk": { "title": "Disk (GB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationVirtualMachines" }, "task": true }, { "name": "deleteVirtualizationVirtualMachines", "summary": "virtualization_virtual-machines_bulk_delete", "description": "virtualization_virtual-machines_bulk_delete", "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": "/deleteVirtualizationVirtualMachines" }, "task": true }, { "name": "getVirtualizationVirtualMachinesId", "summary": "virtualization_virtual-machines_read", "description": "virtualization_virtual-machines_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual machine.: 123", "required": true, "schema": { "title": "id", "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": "/getVirtualizationVirtualMachinesId" }, "task": true }, { "name": "putVirtualizationVirtualMachinesId", "summary": "virtualization_virtual-machines_update", "description": "virtualization_virtual-machines_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual machine.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, staged, failed, decommissioning]\", \"site\": 123, \"cluster\": 123, \"device\": 123, \"role\": 123, \"tenant\": 123, \"platform\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"vcpus\": 123, \"memory\": 123, \"disk\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "decommissioning" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "vcpus": { "title": "VCPUs", "type": "number", "minimum": 0.01, "x-nullable": true }, "memory": { "title": "Memory (MB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "disk": { "title": "Disk (GB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putVirtualizationVirtualMachinesId" }, "task": true }, { "name": "patchVirtualizationVirtualMachinesId", "summary": "virtualization_virtual-machines_partial_update", "description": "virtualization_virtual-machines_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual machine.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"status\": \"Must be one of [offline, active, planned, staged, failed, decommissioning]\", \"site\": 123, \"cluster\": 123, \"device\": 123, \"role\": 123, \"tenant\": 123, \"platform\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"vcpus\": 123, \"memory\": 123, \"disk\": 123, \"comments\": \"string\", \"local_context_data\": \"object\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"config_context\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "offline", "active", "planned", "staged", "failed", "decommissioning" ] }, "site": { "title": "Site", "type": "integer", "x-nullable": true }, "cluster": { "title": "Cluster", "type": "integer", "x-nullable": true }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "role": { "title": "Role", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "platform": { "title": "Platform", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "vcpus": { "title": "VCPUs", "type": "number", "minimum": 0.01, "x-nullable": true }, "memory": { "title": "Memory (MB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "disk": { "title": "Disk (GB)", "type": "integer", "maximum": 2147483647, "minimum": 0, "x-nullable": true }, "comments": { "title": "Comments", "type": "string" }, "local_context_data": { "title": "Local context data", "type": "object", "x-nullable": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "config_context": { "title": "Config context", "type": "object", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchVirtualizationVirtualMachinesId" }, "task": true }, { "name": "deleteVirtualizationVirtualMachinesId", "summary": "virtualization_virtual-machines_delete", "description": "virtualization_virtual-machines_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual machine.: 123", "required": true, "schema": { "title": "id", "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": "/deleteVirtualizationVirtualMachinesId" }, "task": true }, { "name": "getWirelessWirelessLanGroups", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "parentId", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentId", "type": "string" } }, { "name": "parent", "type": "string", "info": ": string", "required": false, "schema": { "title": "parent", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "parentIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentIdN", "type": "string" } }, { "name": "parentN", "type": "string", "info": ": string", "required": false, "schema": { "title": "parentN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "wirelesslan_count": { "title": "Wirelesslan count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "wirelesslan_count": { "title": "Wirelesslan count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWirelessWirelessLanGroups" }, "task": true }, { "name": "postWirelessWirelessLanGroups", "summary": "wireless_wireless-lan-groups_create", "description": "wireless_wireless-lan-groups_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"wirelesslan_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "wirelesslan_count": { "title": "Wirelesslan count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWirelessWirelessLanGroups" }, "task": true }, { "name": "putWirelessWirelessLanGroups", "summary": "wireless_wireless-lan-groups_bulk_update", "description": "wireless_wireless-lan-groups_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"wirelesslan_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "wirelesslan_count": { "title": "Wirelesslan count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWirelessWirelessLanGroups" }, "task": true }, { "name": "patchWirelessWirelessLanGroups", "summary": "wireless_wireless-lan-groups_bulk_partial_update", "description": "wireless_wireless-lan-groups_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"wirelesslan_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "wirelesslan_count": { "title": "Wirelesslan count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchWirelessWirelessLanGroups" }, "task": true }, { "name": "deleteWirelessWirelessLanGroups", "summary": "wireless_wireless-lan-groups_bulk_delete", "description": "wireless_wireless-lan-groups_bulk_delete", "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": "/deleteWirelessWirelessLanGroups" }, "task": true }, { "name": "getWirelessWirelessLanGroupsId", "summary": "wireless_wireless-lan-groups_read", "description": "wireless_wireless-lan-groups_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this Wireless LAN Group.: 123", "required": true, "schema": { "title": "id", "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": "/getWirelessWirelessLanGroupsId" }, "task": true }, { "name": "putWirelessWirelessLanGroupsId", "summary": "wireless_wireless-lan-groups_update", "description": "wireless_wireless-lan-groups_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this Wireless LAN Group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"wirelesslan_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "wirelesslan_count": { "title": "Wirelesslan count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWirelessWirelessLanGroupsId" }, "task": true }, { "name": "patchWirelessWirelessLanGroupsId", "summary": "wireless_wireless-lan-groups_partial_update", "description": "wireless_wireless-lan-groups_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this Wireless LAN Group.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"parent\": 123, \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"wirelesslan_count\": 123, \"_depth\": 123}", "required": true, "schema": { "required": [ "name", "slug", "parent" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "parent": { "title": "Parent", "type": "integer", "x-nullable": true }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "wirelesslan_count": { "title": "Wirelesslan count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchWirelessWirelessLanGroupsId" }, "task": true }, { "name": "deleteWirelessWirelessLanGroupsId", "summary": "wireless_wireless-lan-groups_delete", "description": "wireless_wireless-lan-groups_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this Wireless LAN Group.: 123", "required": true, "schema": { "title": "id", "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": "/deleteWirelessWirelessLanGroupsId" }, "task": true }, { "name": "getWirelessWirelessLans", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "ssid", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssid", "type": "string" } }, { "name": "authPsk", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPsk", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "groupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "group", "type": "string", "info": ": string", "required": false, "schema": { "title": "group", "type": "string" } }, { "name": "vlanId", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlanId", "type": "string" } }, { "name": "authType", "type": "string", "info": ": string", "required": false, "schema": { "title": "authType", "type": "string" } }, { "name": "authCipher", "type": "string", "info": ": string", "required": false, "schema": { "title": "authCipher", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "ssidN", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidN", "type": "string" } }, { "name": "ssidIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidIc", "type": "string" } }, { "name": "ssidNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidNic", "type": "string" } }, { "name": "ssidIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidIew", "type": "string" } }, { "name": "ssidNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidNiew", "type": "string" } }, { "name": "ssidIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidIsw", "type": "string" } }, { "name": "ssidNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidNisw", "type": "string" } }, { "name": "ssidIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidIe", "type": "string" } }, { "name": "ssidNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidNie", "type": "string" } }, { "name": "authPskN", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskN", "type": "string" } }, { "name": "authPskIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskIc", "type": "string" } }, { "name": "authPskNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskNic", "type": "string" } }, { "name": "authPskIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskIew", "type": "string" } }, { "name": "authPskNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskNiew", "type": "string" } }, { "name": "authPskIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskIsw", "type": "string" } }, { "name": "authPskNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskNisw", "type": "string" } }, { "name": "authPskIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskIe", "type": "string" } }, { "name": "authPskNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "groupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupIdN", "type": "string" } }, { "name": "groupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "groupN", "type": "string" } }, { "name": "vlanIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "vlanIdN", "type": "string" } }, { "name": "authTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "authTypeN", "type": "string" } }, { "name": "authCipherN", "type": "string", "info": ": string", "required": false, "schema": { "title": "authCipherN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "ssid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "group": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "wirelesslan_count": { "title": "Wirelesslan count", "type": "integer", "readOnly": true }, "_depth": { "title": "depth", "type": "integer", "readOnly": true } }, "x-nullable": true }, "vlan": { "required": [ "vid", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "vid": { "title": "ID", "type": "integer", "maximum": 4094, "minimum": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 } }, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "auth_type": { "title": "Auth type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Open", "WEP", "WPA Personal (PSK)", "WPA Enterprise" ] }, "value": { "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] } } }, "auth_cipher": { "title": "Auth cipher", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Auto", "TKIP", "AES" ] }, "value": { "type": "string", "enum": [ "auto", "tkip", "aes" ] } } }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWirelessWirelessLans" }, "task": true }, { "name": "postWirelessWirelessLans", "summary": "wireless_wireless-lans_create", "description": "wireless_wireless-lans_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"ssid\": \"string\", \"description\": \"string\", \"group\": 123, \"vlan\": 123, \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "ssid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWirelessWirelessLans" }, "task": true }, { "name": "putWirelessWirelessLans", "summary": "wireless_wireless-lans_bulk_update", "description": "wireless_wireless-lans_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"ssid\": \"string\", \"description\": \"string\", \"group\": 123, \"vlan\": 123, \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "ssid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWirelessWirelessLans" }, "task": true }, { "name": "patchWirelessWirelessLans", "summary": "wireless_wireless-lans_bulk_partial_update", "description": "wireless_wireless-lans_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"ssid\": \"string\", \"description\": \"string\", \"group\": 123, \"vlan\": 123, \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "ssid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchWirelessWirelessLans" }, "task": true }, { "name": "deleteWirelessWirelessLans", "summary": "wireless_wireless-lans_bulk_delete", "description": "wireless_wireless-lans_bulk_delete", "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": "/deleteWirelessWirelessLans" }, "task": true }, { "name": "getWirelessWirelessLansId", "summary": "wireless_wireless-lans_read", "description": "wireless_wireless-lans_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this Wireless LAN.: 123", "required": true, "schema": { "title": "id", "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": "/getWirelessWirelessLansId" }, "task": true }, { "name": "putWirelessWirelessLansId", "summary": "wireless_wireless-lans_update", "description": "wireless_wireless-lans_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this Wireless LAN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"ssid\": \"string\", \"description\": \"string\", \"group\": 123, \"vlan\": 123, \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "ssid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWirelessWirelessLansId" }, "task": true }, { "name": "patchWirelessWirelessLansId", "summary": "wireless_wireless-lans_partial_update", "description": "wireless_wireless-lans_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this Wireless LAN.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"ssid\": \"string\", \"description\": \"string\", \"group\": 123, \"vlan\": 123, \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "ssid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "group": { "title": "Group", "type": "integer", "x-nullable": true }, "vlan": { "title": "VLAN", "type": "integer", "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchWirelessWirelessLansId" }, "task": true }, { "name": "deleteWirelessWirelessLansId", "summary": "wireless_wireless-lans_delete", "description": "wireless_wireless-lans_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this Wireless LAN.: 123", "required": true, "schema": { "title": "id", "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": "/deleteWirelessWirelessLansId" }, "task": true }, { "name": "getWirelessWirelessLinks", "summary": "Overrides ListModelMixin to allow processing ExportTemplates.", "description": "Overrides ListModelMixin to allow processing ExportTemplates.", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "ssid", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssid", "type": "string" } }, { "name": "authPsk", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPsk", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "interfaceAId", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceAId", "type": "string" } }, { "name": "interfaceBId", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceBId", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "authType", "type": "string", "info": ": string", "required": false, "schema": { "title": "authType", "type": "string" } }, { "name": "authCipher", "type": "string", "info": ": string", "required": false, "schema": { "title": "authCipher", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "ssidN", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidN", "type": "string" } }, { "name": "ssidIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidIc", "type": "string" } }, { "name": "ssidNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidNic", "type": "string" } }, { "name": "ssidIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidIew", "type": "string" } }, { "name": "ssidNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidNiew", "type": "string" } }, { "name": "ssidIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidIsw", "type": "string" } }, { "name": "ssidNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidNisw", "type": "string" } }, { "name": "ssidIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidIe", "type": "string" } }, { "name": "ssidNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "ssidNie", "type": "string" } }, { "name": "authPskN", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskN", "type": "string" } }, { "name": "authPskIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskIc", "type": "string" } }, { "name": "authPskNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskNic", "type": "string" } }, { "name": "authPskIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskIew", "type": "string" } }, { "name": "authPskNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskNiew", "type": "string" } }, { "name": "authPskIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskIsw", "type": "string" } }, { "name": "authPskNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskNisw", "type": "string" } }, { "name": "authPskIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskIe", "type": "string" } }, { "name": "authPskNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "authPskNie", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "interfaceAIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceAIdN", "type": "string" } }, { "name": "interfaceAIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceAIdLte", "type": "string" } }, { "name": "interfaceAIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceAIdLt", "type": "string" } }, { "name": "interfaceAIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceAIdGte", "type": "string" } }, { "name": "interfaceAIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceAIdGt", "type": "string" } }, { "name": "interfaceBIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceBIdN", "type": "string" } }, { "name": "interfaceBIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceBIdLte", "type": "string" } }, { "name": "interfaceBIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceBIdLt", "type": "string" } }, { "name": "interfaceBIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceBIdGte", "type": "string" } }, { "name": "interfaceBIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "interfaceBIdGt", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "authTypeN", "type": "string", "info": ": string", "required": false, "schema": { "title": "authTypeN", "type": "string" } }, { "name": "authCipherN", "type": "string", "info": ": string", "required": false, "schema": { "title": "authCipherN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "interface_a", "interface_b" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "interface_a": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "cable": { "title": "Cable", "type": "integer", "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "x-nullable": true }, "interface_b": { "required": [ "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "cable": { "title": "Cable", "type": "integer", "x-nullable": true }, "_occupied": { "title": "occupied", "type": "boolean", "readOnly": true } }, "x-nullable": true }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32 }, "status": { "title": "Status", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Connected", "Planned", "Decommissioning" ] }, "value": { "type": "string", "enum": [ "connected", "planned", "decommissioning" ] } } }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "auth_type": { "title": "Auth type", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Open", "WEP", "WPA Personal (PSK)", "WPA Enterprise" ] }, "value": { "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] } } }, "auth_cipher": { "title": "Auth cipher", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string", "enum": [ "Auto", "TKIP", "AES" ] }, "value": { "type": "string", "enum": [ "auto", "tkip", "aes" ] } } }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWirelessWirelessLinks" }, "task": true }, { "name": "postWirelessWirelessLinks", "summary": "wireless_wireless-links_create", "description": "wireless_wireless-links_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"interface_a\": 123, \"interface_b\": 123, \"ssid\": \"string\", \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "interface_a", "interface_b" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "interface_a": { "title": "Interface A", "type": "integer" }, "interface_b": { "title": "Interface B", "type": "integer" }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32 }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWirelessWirelessLinks" }, "task": true }, { "name": "putWirelessWirelessLinks", "summary": "wireless_wireless-links_bulk_update", "description": "wireless_wireless-links_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"interface_a\": 123, \"interface_b\": 123, \"ssid\": \"string\", \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "interface_a", "interface_b" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "interface_a": { "title": "Interface A", "type": "integer" }, "interface_b": { "title": "Interface B", "type": "integer" }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32 }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWirelessWirelessLinks" }, "task": true }, { "name": "patchWirelessWirelessLinks", "summary": "wireless_wireless-links_bulk_partial_update", "description": "wireless_wireless-links_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"interface_a\": 123, \"interface_b\": 123, \"ssid\": \"string\", \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "interface_a", "interface_b" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "interface_a": { "title": "Interface A", "type": "integer" }, "interface_b": { "title": "Interface B", "type": "integer" }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32 }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchWirelessWirelessLinks" }, "task": true }, { "name": "deleteWirelessWirelessLinks", "summary": "wireless_wireless-links_bulk_delete", "description": "wireless_wireless-links_bulk_delete", "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": "/deleteWirelessWirelessLinks" }, "task": true }, { "name": "getWirelessWirelessLinksId", "summary": "wireless_wireless-links_read", "description": "wireless_wireless-links_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this wireless link.: 123", "required": true, "schema": { "title": "id", "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": "/getWirelessWirelessLinksId" }, "task": true }, { "name": "putWirelessWirelessLinksId", "summary": "wireless_wireless-links_update", "description": "wireless_wireless-links_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this wireless link.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"interface_a\": 123, \"interface_b\": 123, \"ssid\": \"string\", \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "interface_a", "interface_b" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "interface_a": { "title": "Interface A", "type": "integer" }, "interface_b": { "title": "Interface B", "type": "integer" }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32 }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWirelessWirelessLinksId" }, "task": true }, { "name": "patchWirelessWirelessLinksId", "summary": "wireless_wireless-links_partial_update", "description": "wireless_wireless-links_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this wireless link.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"interface_a\": 123, \"interface_b\": 123, \"ssid\": \"string\", \"status\": \"Must be one of [connected, planned, decommissioning]\", \"tenant\": 123, \"auth_type\": \"Must be one of [open, wep, wpa-personal, wpa-enterprise]\", \"auth_cipher\": \"Must be one of [auto, tkip, aes]\", \"auth_psk\": \"string\", \"description\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "interface_a", "interface_b" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "interface_a": { "title": "Interface A", "type": "integer" }, "interface_b": { "title": "Interface B", "type": "integer" }, "ssid": { "title": "SSID", "type": "string", "maxLength": 32 }, "status": { "title": "Status", "type": "string", "enum": [ "connected", "planned", "decommissioning" ] }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "auth_type": { "title": "Auth Type", "type": "string", "enum": [ "open", "wep", "wpa-personal", "wpa-enterprise" ] }, "auth_cipher": { "title": "Auth cipher", "type": "string", "enum": [ "auto", "tkip", "aes" ] }, "auth_psk": { "title": "Pre-shared key", "type": "string", "maxLength": 64 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchWirelessWirelessLinksId" }, "task": true }, { "name": "deleteWirelessWirelessLinksId", "summary": "wireless_wireless-links_delete", "description": "wireless_wireless-links_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this wireless link.: 123", "required": true, "schema": { "title": "id", "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": "/deleteWirelessWirelessLinksId" }, "task": true }, { "name": "getDcimVirtualDeviceContexts", "summary": "dcim_virtual-device-contexts_list", "description": "dcim_virtual-device-contexts_list", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "device", "type": "string", "info": ": string", "required": false, "schema": { "title": "device", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "created", "type": "string", "info": ": string", "required": false, "schema": { "title": "created", "type": "string" } }, { "name": "lastUpdated", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdated", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "tag", "type": "string", "info": ": string", "required": false, "schema": { "title": "tag", "type": "string" } }, { "name": "tenantGroupId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupId", "type": "string" } }, { "name": "tenantGroup", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroup", "type": "string" } }, { "name": "tenantId", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tenant", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenant", "type": "string" } }, { "name": "deviceId", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "status", "type": "string", "info": ": string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "hasPrimaryIp", "type": "string", "info": ": string", "required": false, "schema": { "title": "hasPrimaryIp", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "deviceN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceN", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "nameEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameEmpty", "type": "string" } }, { "name": "createdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdN", "type": "string" } }, { "name": "createdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLte", "type": "string" } }, { "name": "createdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdLt", "type": "string" } }, { "name": "createdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGte", "type": "string" } }, { "name": "createdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "createdGt", "type": "string" } }, { "name": "lastUpdatedN", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedN", "type": "string" } }, { "name": "lastUpdatedLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLte", "type": "string" } }, { "name": "lastUpdatedLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedLt", "type": "string" } }, { "name": "lastUpdatedGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGte", "type": "string" } }, { "name": "lastUpdatedGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "lastUpdatedGt", "type": "string" } }, { "name": "tagN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tagN", "type": "string" } }, { "name": "tenantGroupIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupIdN", "type": "string" } }, { "name": "tenantGroupN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantGroupN", "type": "string" } }, { "name": "tenantIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantIdN", "type": "string" } }, { "name": "tenantN", "type": "string", "info": ": string", "required": false, "schema": { "title": "tenantN", "type": "string" } }, { "name": "deviceIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "deviceIdN", "type": "string" } }, { "name": "statusN", "type": "string", "info": ": string", "required": false, "schema": { "title": "statusN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "name", "device", "status" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "device": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "x-nullable": true } } }, "identifier": { "title": "Identifier", "description": "Numeric identifier unique to the parent device", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "tenant": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 } }, "x-nullable": true }, "primary_ip": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "primary_ip4": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "primary_ip6": { "required": [ "address" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "family": { "title": "Family", "type": "integer", "readOnly": true }, "address": { "title": "Address", "description": "IPv4 or IPv6 address (with mask)", "type": "string" } } }, "status": { "title": "Status", "type": "string", "enum": [ "active", "planned", "offline" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "interface_count": { "title": "Interface count", "type": "integer", "readOnly": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDcimVirtualDeviceContexts" }, "task": true }, { "name": "postDcimVirtualDeviceContexts", "summary": "dcim_virtual-device-contexts_create", "description": "dcim_virtual-device-contexts_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device\": 123, \"identifier\": 123, \"tenant\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"status\": \"Must be one of [active, planned, offline]\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"interface_count\": 123}", "required": true, "schema": { "required": [ "name", "status" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "identifier": { "title": "Identifier", "description": "Numeric identifier unique to the parent device", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "planned", "offline" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "interface_count": { "title": "Interface count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDcimVirtualDeviceContexts" }, "task": true }, { "name": "putDcimVirtualDeviceContexts", "summary": "dcim_virtual-device-contexts_bulk_update", "description": "dcim_virtual-device-contexts_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device\": 123, \"identifier\": 123, \"tenant\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"status\": \"Must be one of [active, planned, offline]\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"interface_count\": 123}", "required": true, "schema": { "required": [ "name", "status" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "identifier": { "title": "Identifier", "description": "Numeric identifier unique to the parent device", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "planned", "offline" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "interface_count": { "title": "Interface count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimVirtualDeviceContexts" }, "task": true }, { "name": "patchDcimVirtualDeviceContexts", "summary": "dcim_virtual-device-contexts_bulk_partial_update", "description": "dcim_virtual-device-contexts_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device\": 123, \"identifier\": 123, \"tenant\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"status\": \"Must be one of [active, planned, offline]\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"interface_count\": 123}", "required": true, "schema": { "required": [ "name", "status" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "identifier": { "title": "Identifier", "description": "Numeric identifier unique to the parent device", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "planned", "offline" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "interface_count": { "title": "Interface count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimVirtualDeviceContexts" }, "task": true }, { "name": "deleteDcimVirtualDeviceContexts", "summary": "dcim_virtual-device-contexts_bulk_delete", "description": "dcim_virtual-device-contexts_bulk_delete", "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": "/deleteDcimVirtualDeviceContexts" }, "task": true }, { "name": "getDcimVirtualDeviceContextsId", "summary": "dcim_virtual-device-contexts_read", "description": "dcim_virtual-device-contexts_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual device context.: 123", "required": true, "schema": { "title": "id", "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": "/getDcimVirtualDeviceContextsId" }, "task": true }, { "name": "putDcimVirtualDeviceContextsId", "summary": "dcim_virtual-device-contexts_update", "description": "dcim_virtual-device-contexts_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual device context.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device\": 123, \"identifier\": 123, \"tenant\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"status\": \"Must be one of [active, planned, offline]\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"interface_count\": 123}", "required": true, "schema": { "required": [ "name", "status" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "identifier": { "title": "Identifier", "description": "Numeric identifier unique to the parent device", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "planned", "offline" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "interface_count": { "title": "Interface count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putDcimVirtualDeviceContextsId" }, "task": true }, { "name": "patchDcimVirtualDeviceContextsId", "summary": "dcim_virtual-device-contexts_partial_update", "description": "dcim_virtual-device-contexts_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual device context.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"device\": 123, \"identifier\": 123, \"tenant\": 123, \"primary_ip\": \"string\", \"primary_ip4\": 123, \"primary_ip6\": 123, \"status\": \"Must be one of [active, planned, offline]\", \"description\": \"string\", \"comments\": \"string\", \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"created\": \"string\", \"last_updated\": \"string\", \"interface_count\": 123}", "required": true, "schema": { "required": [ "name", "status" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 64, "minLength": 1 }, "device": { "title": "Device", "type": "integer", "x-nullable": true }, "identifier": { "title": "Identifier", "description": "Numeric identifier unique to the parent device", "type": "integer", "maximum": 32767, "minimum": 0, "x-nullable": true }, "tenant": { "title": "Tenant", "type": "integer", "x-nullable": true }, "primary_ip": { "title": "Primary ip", "type": "string", "readOnly": true }, "primary_ip4": { "title": "Primary IPv4", "type": "integer", "x-nullable": true }, "primary_ip6": { "title": "Primary IPv6", "type": "integer", "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "active", "planned", "offline" ] }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "comments": { "title": "Comments", "type": "string" }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "interface_count": { "title": "Interface count", "type": "integer", "readOnly": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchDcimVirtualDeviceContextsId" }, "task": true }, { "name": "deleteDcimVirtualDeviceContextsId", "summary": "dcim_virtual-device-contexts_delete", "description": "dcim_virtual-device-contexts_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this virtual device context.: 123", "required": true, "schema": { "title": "id", "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": "/deleteDcimVirtualDeviceContextsId" }, "task": true }, { "name": "getExtrasSavedFilters", "summary": "extras_saved-filters_list", "description": "extras_saved-filters_list", "input": [ { "name": "id", "type": "string", "info": ": string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "contentTypes", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypes", "type": "string" } }, { "name": "name", "type": "string", "info": ": string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "slug", "type": "string", "info": ": string", "required": false, "schema": { "title": "slug", "type": "string" } }, { "name": "description", "type": "string", "info": ": string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "enabled", "type": "string", "info": ": string", "required": false, "schema": { "title": "enabled", "type": "string" } }, { "name": "shared", "type": "string", "info": ": string", "required": false, "schema": { "title": "shared", "type": "string" } }, { "name": "weight", "type": "string", "info": ": string", "required": false, "schema": { "title": "weight", "type": "string" } }, { "name": "q", "type": "string", "info": ": string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "contentTypeId", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeId", "type": "string" } }, { "name": "userId", "type": "string", "info": ": string", "required": false, "schema": { "title": "userId", "type": "string" } }, { "name": "user", "type": "string", "info": ": string", "required": false, "schema": { "title": "user", "type": "string" } }, { "name": "usable", "type": "string", "info": ": string", "required": false, "schema": { "title": "usable", "type": "string" } }, { "name": "idN", "type": "string", "info": ": string", "required": false, "schema": { "title": "idN", "type": "string" } }, { "name": "idLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLte", "type": "string" } }, { "name": "idLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idLt", "type": "string" } }, { "name": "idGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGte", "type": "string" } }, { "name": "idGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "idGt", "type": "string" } }, { "name": "contentTypesN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesN", "type": "string" } }, { "name": "contentTypesIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIc", "type": "string" } }, { "name": "contentTypesNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNic", "type": "string" } }, { "name": "contentTypesIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIew", "type": "string" } }, { "name": "contentTypesNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNiew", "type": "string" } }, { "name": "contentTypesIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIsw", "type": "string" } }, { "name": "contentTypesNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNisw", "type": "string" } }, { "name": "contentTypesIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesIe", "type": "string" } }, { "name": "contentTypesNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypesNie", "type": "string" } }, { "name": "nameN", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameN", "type": "string" } }, { "name": "nameIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIc", "type": "string" } }, { "name": "nameNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNic", "type": "string" } }, { "name": "nameIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIew", "type": "string" } }, { "name": "nameNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNiew", "type": "string" } }, { "name": "nameIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIsw", "type": "string" } }, { "name": "nameNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNisw", "type": "string" } }, { "name": "nameIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameIe", "type": "string" } }, { "name": "nameNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameNie", "type": "string" } }, { "name": "nameEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "nameEmpty", "type": "string" } }, { "name": "slugN", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugN", "type": "string" } }, { "name": "slugIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIc", "type": "string" } }, { "name": "slugNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNic", "type": "string" } }, { "name": "slugIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIew", "type": "string" } }, { "name": "slugNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNiew", "type": "string" } }, { "name": "slugIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIsw", "type": "string" } }, { "name": "slugNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNisw", "type": "string" } }, { "name": "slugIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugIe", "type": "string" } }, { "name": "slugNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugNie", "type": "string" } }, { "name": "slugEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "slugEmpty", "type": "string" } }, { "name": "descriptionN", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionN", "type": "string" } }, { "name": "descriptionIc", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIc", "type": "string" } }, { "name": "descriptionNic", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNic", "type": "string" } }, { "name": "descriptionIew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIew", "type": "string" } }, { "name": "descriptionNiew", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNiew", "type": "string" } }, { "name": "descriptionIsw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIsw", "type": "string" } }, { "name": "descriptionNisw", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNisw", "type": "string" } }, { "name": "descriptionIe", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionIe", "type": "string" } }, { "name": "descriptionNie", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionNie", "type": "string" } }, { "name": "descriptionEmpty", "type": "string", "info": ": string", "required": false, "schema": { "title": "descriptionEmpty", "type": "string" } }, { "name": "weightN", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightN", "type": "string" } }, { "name": "weightLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightLte", "type": "string" } }, { "name": "weightLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightLt", "type": "string" } }, { "name": "weightGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightGte", "type": "string" } }, { "name": "weightGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "weightGt", "type": "string" } }, { "name": "contentTypeIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdN", "type": "string" } }, { "name": "contentTypeIdLte", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdLte", "type": "string" } }, { "name": "contentTypeIdLt", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdLt", "type": "string" } }, { "name": "contentTypeIdGte", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdGte", "type": "string" } }, { "name": "contentTypeIdGt", "type": "string", "info": ": string", "required": false, "schema": { "title": "contentTypeIdGt", "type": "string" } }, { "name": "userIdN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userIdN", "type": "string" } }, { "name": "userN", "type": "string", "info": ": string", "required": false, "schema": { "title": "userN", "type": "string" } }, { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "content_types", "name", "slug", "parameters" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "user": { "title": "User", "type": "integer", "x-nullable": true }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "enabled": { "title": "Enabled", "type": "boolean" }, "shared": { "title": "Shared", "type": "boolean" }, "parameters": { "title": "Parameters", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getExtrasSavedFilters" }, "task": true }, { "name": "postExtrasSavedFilters", "summary": "extras_saved-filters_create", "description": "extras_saved-filters_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"user\": 123, \"weight\": 123, \"enabled\": \"boolean\", \"shared\": \"boolean\", \"parameters\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "slug", "parameters" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "user": { "title": "User", "type": "integer", "x-nullable": true }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "enabled": { "title": "Enabled", "type": "boolean" }, "shared": { "title": "Shared", "type": "boolean" }, "parameters": { "title": "Parameters", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtrasSavedFilters" }, "task": true }, { "name": "putExtrasSavedFilters", "summary": "extras_saved-filters_bulk_update", "description": "extras_saved-filters_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"user\": 123, \"weight\": 123, \"enabled\": \"boolean\", \"shared\": \"boolean\", \"parameters\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "slug", "parameters" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "user": { "title": "User", "type": "integer", "x-nullable": true }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "enabled": { "title": "Enabled", "type": "boolean" }, "shared": { "title": "Shared", "type": "boolean" }, "parameters": { "title": "Parameters", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasSavedFilters" }, "task": true }, { "name": "patchExtrasSavedFilters", "summary": "extras_saved-filters_bulk_partial_update", "description": "extras_saved-filters_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"user\": 123, \"weight\": 123, \"enabled\": \"boolean\", \"shared\": \"boolean\", \"parameters\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "slug", "parameters" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "user": { "title": "User", "type": "integer", "x-nullable": true }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "enabled": { "title": "Enabled", "type": "boolean" }, "shared": { "title": "Shared", "type": "boolean" }, "parameters": { "title": "Parameters", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasSavedFilters" }, "task": true }, { "name": "deleteExtrasSavedFilters", "summary": "extras_saved-filters_bulk_delete", "description": "extras_saved-filters_bulk_delete", "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": "/deleteExtrasSavedFilters" }, "task": true }, { "name": "getExtrasSavedFiltersId", "summary": "extras_saved-filters_read", "description": "extras_saved-filters_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this saved filter.: 123", "required": true, "schema": { "title": "id", "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": "/getExtrasSavedFiltersId" }, "task": true }, { "name": "putExtrasSavedFiltersId", "summary": "extras_saved-filters_update", "description": "extras_saved-filters_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this saved filter.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"user\": 123, \"weight\": 123, \"enabled\": \"boolean\", \"shared\": \"boolean\", \"parameters\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "slug", "parameters" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "user": { "title": "User", "type": "integer", "x-nullable": true }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "enabled": { "title": "Enabled", "type": "boolean" }, "shared": { "title": "Shared", "type": "boolean" }, "parameters": { "title": "Parameters", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putExtrasSavedFiltersId" }, "task": true }, { "name": "patchExtrasSavedFiltersId", "summary": "extras_saved-filters_partial_update", "description": "extras_saved-filters_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this saved filter.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"content_types\": \"array\", \"name\": \"string\", \"slug\": \"string\", \"description\": \"string\", \"user\": 123, \"weight\": 123, \"enabled\": \"boolean\", \"shared\": \"boolean\", \"parameters\": \"object\", \"created\": \"string\", \"last_updated\": \"string\"}", "required": true, "schema": { "required": [ "content_types", "name", "slug", "parameters" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "content_types": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "pattern": "^[-a-zA-Z0-9_]+$", "maxLength": 100, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200 }, "user": { "title": "User", "type": "integer", "x-nullable": true }, "weight": { "title": "Weight", "type": "integer", "maximum": 32767, "minimum": 0 }, "enabled": { "title": "Enabled", "type": "boolean" }, "shared": { "title": "Shared", "type": "boolean" }, "parameters": { "title": "Parameters", "type": "object" }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchExtrasSavedFiltersId" }, "task": true }, { "name": "deleteExtrasSavedFiltersId", "summary": "extras_saved-filters_delete", "description": "extras_saved-filters_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this saved filter.: 123", "required": true, "schema": { "title": "id", "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": "/deleteExtrasSavedFiltersId" }, "task": true }, { "name": "getPluginsServicePoolsCandidateConfig", "summary": "plugins_service-pools_candidate-config_list", "description": "plugins_service-pools_candidate-config_list", "input": [ { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "service_order" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "config": { "title": "Config", "type": "string" }, "service_order": { "title": "Service order", "type": "integer" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPluginsServicePoolsCandidateConfig" }, "task": true }, { "name": "postPluginsServicePoolsCandidateConfig", "summary": "plugins_service-pools_candidate-config_create", "description": "plugins_service-pools_candidate-config_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"config\": \"string\", \"service_order\": 123}", "required": true, "schema": { "required": [ "service_order" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "config": { "title": "Config", "type": "string" }, "service_order": { "title": "Service order", "type": "integer" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPluginsServicePoolsCandidateConfig" }, "task": true }, { "name": "putPluginsServicePoolsCandidateConfig", "summary": "plugins_service-pools_candidate-config_bulk_update", "description": "plugins_service-pools_candidate-config_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"config\": \"string\", \"service_order\": 123}", "required": true, "schema": { "required": [ "service_order" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "config": { "title": "Config", "type": "string" }, "service_order": { "title": "Service order", "type": "integer" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putPluginsServicePoolsCandidateConfig" }, "task": true }, { "name": "patchPluginsServicePoolsCandidateConfig", "summary": "plugins_service-pools_candidate-config_bulk_partial_update", "description": "plugins_service-pools_candidate-config_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"config\": \"string\", \"service_order\": 123}", "required": true, "schema": { "required": [ "service_order" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "config": { "title": "Config", "type": "string" }, "service_order": { "title": "Service order", "type": "integer" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchPluginsServicePoolsCandidateConfig" }, "task": true }, { "name": "deletePluginsServicePoolsCandidateConfig", "summary": "plugins_service-pools_candidate-config_bulk_delete", "description": "plugins_service-pools_candidate-config_bulk_delete", "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": "/deletePluginsServicePoolsCandidateConfig" }, "task": true }, { "name": "getPluginsServicePoolsCandidateConfigId", "summary": "plugins_service-pools_candidate-config_read", "description": "plugins_service-pools_candidate-config_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this candidate config.: 123", "required": true, "schema": { "title": "id", "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": "/getPluginsServicePoolsCandidateConfigId" }, "task": true }, { "name": "putPluginsServicePoolsCandidateConfigId", "summary": "plugins_service-pools_candidate-config_update", "description": "plugins_service-pools_candidate-config_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this candidate config.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"config\": \"string\", \"service_order\": 123}", "required": true, "schema": { "required": [ "service_order" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "config": { "title": "Config", "type": "string" }, "service_order": { "title": "Service order", "type": "integer" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putPluginsServicePoolsCandidateConfigId" }, "task": true }, { "name": "patchPluginsServicePoolsCandidateConfigId", "summary": "plugins_service-pools_candidate-config_partial_update", "description": "plugins_service-pools_candidate-config_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this candidate config.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"config\": \"string\", \"service_order\": 123}", "required": true, "schema": { "required": [ "service_order" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "config": { "title": "Config", "type": "string" }, "service_order": { "title": "Service order", "type": "integer" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchPluginsServicePoolsCandidateConfigId" }, "task": true }, { "name": "deletePluginsServicePoolsCandidateConfigId", "summary": "plugins_service-pools_candidate-config_delete", "description": "plugins_service-pools_candidate-config_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this candidate config.: 123", "required": true, "schema": { "title": "id", "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": "/deletePluginsServicePoolsCandidateConfigId" }, "task": true }, { "name": "getPluginsServicePoolsCustomService", "summary": "plugins_service-pools_custom-service_list", "description": "plugins_service-pools_custom-service_list", "input": [ { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "uuid", "name", "service_type", "tmf638_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_type": { "title": "Service type", "type": "string", "enum": [ "PORT A", "L3VPN" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf638_payload": { "title": "Tmf638 payload", "type": "object" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPluginsServicePoolsCustomService" }, "task": true }, { "name": "postPluginsServicePoolsCustomService", "summary": "plugins_service-pools_custom-service_create", "description": "plugins_service-pools_custom-service_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"service_type\": \"Must be one of [PORT A, L3VPN]\", \"description\": \"string\", \"category\": \"string\", \"tmf638_payload\": \"object\"}", "required": true, "schema": { "required": [ "uuid", "name", "service_type", "tmf638_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_type": { "title": "Service type", "type": "string", "enum": [ "PORT A", "L3VPN" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf638_payload": { "title": "Tmf638 payload", "type": "object" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPluginsServicePoolsCustomService" }, "task": true }, { "name": "putPluginsServicePoolsCustomService", "summary": "plugins_service-pools_custom-service_bulk_update", "description": "plugins_service-pools_custom-service_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"service_type\": \"Must be one of [PORT A, L3VPN]\", \"description\": \"string\", \"category\": \"string\", \"tmf638_payload\": \"object\"}", "required": true, "schema": { "required": [ "uuid", "name", "service_type", "tmf638_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_type": { "title": "Service type", "type": "string", "enum": [ "PORT A", "L3VPN" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf638_payload": { "title": "Tmf638 payload", "type": "object" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putPluginsServicePoolsCustomService" }, "task": true }, { "name": "patchPluginsServicePoolsCustomService", "summary": "plugins_service-pools_custom-service_bulk_partial_update", "description": "plugins_service-pools_custom-service_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"service_type\": \"Must be one of [PORT A, L3VPN]\", \"description\": \"string\", \"category\": \"string\", \"tmf638_payload\": \"object\"}", "required": true, "schema": { "required": [ "uuid", "name", "service_type", "tmf638_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_type": { "title": "Service type", "type": "string", "enum": [ "PORT A", "L3VPN" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf638_payload": { "title": "Tmf638 payload", "type": "object" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchPluginsServicePoolsCustomService" }, "task": true }, { "name": "deletePluginsServicePoolsCustomService", "summary": "plugins_service-pools_custom-service_bulk_delete", "description": "plugins_service-pools_custom-service_bulk_delete", "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": "/deletePluginsServicePoolsCustomService" }, "task": true }, { "name": "getPluginsServicePoolsCustomServiceId", "summary": "plugins_service-pools_custom-service_read", "description": "plugins_service-pools_custom-service_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom service.: 123", "required": true, "schema": { "title": "id", "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": "/getPluginsServicePoolsCustomServiceId" }, "task": true }, { "name": "putPluginsServicePoolsCustomServiceId", "summary": "plugins_service-pools_custom-service_update", "description": "plugins_service-pools_custom-service_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom service.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"service_type\": \"Must be one of [PORT A, L3VPN]\", \"description\": \"string\", \"category\": \"string\", \"tmf638_payload\": \"object\"}", "required": true, "schema": { "required": [ "uuid", "name", "service_type", "tmf638_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_type": { "title": "Service type", "type": "string", "enum": [ "PORT A", "L3VPN" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf638_payload": { "title": "Tmf638 payload", "type": "object" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putPluginsServicePoolsCustomServiceId" }, "task": true }, { "name": "patchPluginsServicePoolsCustomServiceId", "summary": "plugins_service-pools_custom-service_partial_update", "description": "plugins_service-pools_custom-service_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom service.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"service_type\": \"Must be one of [PORT A, L3VPN]\", \"description\": \"string\", \"category\": \"string\", \"tmf638_payload\": \"object\"}", "required": true, "schema": { "required": [ "uuid", "name", "service_type", "tmf638_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "service_type": { "title": "Service type", "type": "string", "enum": [ "PORT A", "L3VPN" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf638_payload": { "title": "Tmf638 payload", "type": "object" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchPluginsServicePoolsCustomServiceId" }, "task": true }, { "name": "deletePluginsServicePoolsCustomServiceId", "summary": "plugins_service-pools_custom-service_delete", "description": "plugins_service-pools_custom-service_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this custom service.: 123", "required": true, "schema": { "title": "id", "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": "/deletePluginsServicePoolsCustomServiceId" }, "task": true }, { "name": "getPluginsServicePoolsServiceOrder", "summary": "plugins_service-pools_service-order_list", "description": "plugins_service-pools_service-order_list", "input": [ { "name": "ordering", "type": "string", "info": "Which field to use when ordering the results.: string", "required": false, "schema": { "title": "ordering", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of results to return per page.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The initial index from which to return the results.: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "x-nullable": true }, "previous": { "type": "string", "x-nullable": true }, "results": { "type": "array", "items": { "required": [ "uuid", "name", "state", "tmf641_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "state": { "title": "State", "type": "string", "enum": [ "open", "in process", "released", "completed", "confirmed", "rejected", "cancelled" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "external_id": { "title": "External id", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf641_payload": { "title": "Tmf641 payload", "type": "object" }, "service_name": { "title": "Service name", "type": "integer", "x-nullable": true } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPluginsServicePoolsServiceOrder" }, "task": true }, { "name": "postPluginsServicePoolsServiceOrder", "summary": "plugins_service-pools_service-order_create", "description": "plugins_service-pools_service-order_create", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"state\": \"Must be one of [open, in process, released, completed, confirmed, rejected, cancelled]\", \"description\": \"string\", \"category\": \"string\", \"external_id\": \"string\", \"tmf641_payload\": \"object\", \"service_name\": 123}", "required": true, "schema": { "required": [ "uuid", "name", "state", "tmf641_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "state": { "title": "State", "type": "string", "enum": [ "open", "in process", "released", "completed", "confirmed", "rejected", "cancelled" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "external_id": { "title": "External id", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf641_payload": { "title": "Tmf641 payload", "type": "object" }, "service_name": { "title": "Service name", "type": "integer", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPluginsServicePoolsServiceOrder" }, "task": true }, { "name": "putPluginsServicePoolsServiceOrder", "summary": "plugins_service-pools_service-order_bulk_update", "description": "plugins_service-pools_service-order_bulk_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"state\": \"Must be one of [open, in process, released, completed, confirmed, rejected, cancelled]\", \"description\": \"string\", \"category\": \"string\", \"external_id\": \"string\", \"tmf641_payload\": \"object\", \"service_name\": 123}", "required": true, "schema": { "required": [ "uuid", "name", "state", "tmf641_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "state": { "title": "State", "type": "string", "enum": [ "open", "in process", "released", "completed", "confirmed", "rejected", "cancelled" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "external_id": { "title": "External id", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf641_payload": { "title": "Tmf641 payload", "type": "object" }, "service_name": { "title": "Service name", "type": "integer", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putPluginsServicePoolsServiceOrder" }, "task": true }, { "name": "patchPluginsServicePoolsServiceOrder", "summary": "plugins_service-pools_service-order_bulk_partial_update", "description": "plugins_service-pools_service-order_bulk_partial_update", "input": [ { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"state\": \"Must be one of [open, in process, released, completed, confirmed, rejected, cancelled]\", \"description\": \"string\", \"category\": \"string\", \"external_id\": \"string\", \"tmf641_payload\": \"object\", \"service_name\": 123}", "required": true, "schema": { "required": [ "uuid", "name", "state", "tmf641_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "state": { "title": "State", "type": "string", "enum": [ "open", "in process", "released", "completed", "confirmed", "rejected", "cancelled" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "external_id": { "title": "External id", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf641_payload": { "title": "Tmf641 payload", "type": "object" }, "service_name": { "title": "Service name", "type": "integer", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchPluginsServicePoolsServiceOrder" }, "task": true }, { "name": "deletePluginsServicePoolsServiceOrder", "summary": "plugins_service-pools_service-order_bulk_delete", "description": "plugins_service-pools_service-order_bulk_delete", "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": "/deletePluginsServicePoolsServiceOrder" }, "task": true }, { "name": "getPluginsServicePoolsServiceOrderId", "summary": "plugins_service-pools_service-order_read", "description": "plugins_service-pools_service-order_read", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service order.: 123", "required": true, "schema": { "title": "id", "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": "/getPluginsServicePoolsServiceOrderId" }, "task": true }, { "name": "putPluginsServicePoolsServiceOrderId", "summary": "plugins_service-pools_service-order_update", "description": "plugins_service-pools_service-order_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service order.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"state\": \"Must be one of [open, in process, released, completed, confirmed, rejected, cancelled]\", \"description\": \"string\", \"category\": \"string\", \"external_id\": \"string\", \"tmf641_payload\": \"object\", \"service_name\": 123}", "required": true, "schema": { "required": [ "uuid", "name", "state", "tmf641_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "state": { "title": "State", "type": "string", "enum": [ "open", "in process", "released", "completed", "confirmed", "rejected", "cancelled" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "external_id": { "title": "External id", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf641_payload": { "title": "Tmf641 payload", "type": "object" }, "service_name": { "title": "Service name", "type": "integer", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putPluginsServicePoolsServiceOrderId" }, "task": true }, { "name": "patchPluginsServicePoolsServiceOrderId", "summary": "plugins_service-pools_service-order_partial_update", "description": "plugins_service-pools_service-order_partial_update", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service order.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "data", "type": "object", "info": ": {\"id\": 123, \"tags\": [{\"id\": 123, \"url\": \"string\", \"display\": \"string\", \"name\": \"string\", \"slug\": \"string\", \"color\": \"string\"}], \"custom_fields\": \"object\", \"display\": \"string\", \"url\": \"string\", \"created\": \"string\", \"last_updated\": \"string\", \"custom_field_data\": \"object\", \"uuid\": \"string\", \"name\": \"string\", \"state\": \"Must be one of [open, in process, released, completed, confirmed, rejected, cancelled]\", \"description\": \"string\", \"category\": \"string\", \"external_id\": \"string\", \"tmf641_payload\": \"object\", \"service_name\": 123}", "required": true, "schema": { "required": [ "uuid", "name", "state", "tmf641_payload" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "tags": { "type": "array", "items": { "required": [ "name", "slug" ], "type": "object", "properties": { "id": { "title": "Id", "type": "integer", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "display": { "title": "Display", "type": "string", "readOnly": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "color": { "title": "Color", "type": "string", "pattern": "^[0-9a-f]{6}$", "maxLength": 6, "minLength": 1 } } } }, "custom_fields": { "title": "Custom fields", "type": "object", "default": {} }, "display": { "title": "Display", "type": "string", "readOnly": true }, "url": { "title": "Url", "type": "string", "readOnly": true }, "created": { "title": "Created", "type": "string", "readOnly": true, "x-nullable": true }, "last_updated": { "title": "Last updated", "type": "string", "readOnly": true, "x-nullable": true }, "custom_field_data": { "title": "Custom field data", "type": "object" }, "uuid": { "title": "Uuid", "type": "string", "maxLength": 36, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "state": { "title": "State", "type": "string", "enum": [ "open", "in process", "released", "completed", "confirmed", "rejected", "cancelled" ] }, "description": { "title": "Description", "type": "string", "maxLength": 100, "x-nullable": true }, "category": { "title": "Category", "type": "string", "maxLength": 100, "x-nullable": true }, "external_id": { "title": "External id", "type": "string", "maxLength": 100, "x-nullable": true }, "tmf641_payload": { "title": "Tmf641 payload", "type": "object" }, "service_name": { "title": "Service name", "type": "integer", "x-nullable": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/patchPluginsServicePoolsServiceOrderId" }, "task": true }, { "name": "deletePluginsServicePoolsServiceOrderId", "summary": "plugins_service-pools_service-order_delete", "description": "plugins_service-pools_service-order_delete", "input": [ { "name": "id", "type": "number", "info": "A unique integer value identifying this service order.: 123", "required": true, "schema": { "title": "id", "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": "/deletePluginsServicePoolsServiceOrderId" }, "task": true } ], "views": [] }