{ "id": "@itentialopensource/adapter-netterrain", "type": "Adapter", "export": "Netterrain", "title": "Netterrain", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "rESTfulCardsGet", "summary": "Gets the cards collection.", "description": "Gets the cards collection.", "input": [ { "name": "parentTypeGroup", "type": "string", "info": "Parent node type group: either \"devices\" or \"cards\".: string", "required": true, "schema": { "title": "parentTypeGroup", "type": "string" } }, { "name": "parentId", "type": "number", "info": "Parent node (device or card) id.: 123", "required": true, "schema": { "title": "parentId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCardsGet" }, "task": true }, { "name": "getWapiV1Cards", "summary": "Gets the cards collection.", "description": "Gets the cards collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1Cards" }, "task": true }, { "name": "rESTfulCardsGetById", "summary": "Gets the card.", "description": "Card id example: 24000000000123", "input": [ { "name": "id", "type": "number", "info": "Card id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "base_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "card_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "peak_power": { "type": "number" }, "weight": { "type": "number" }, "status": { "type": "string" }, "cards": { "type": "object", "properties": { "href": { "type": "string" } } }, "slots": { "type": "object", "properties": { "href": { "type": "string" } } }, "ports": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCardsGetById" }, "task": true }, { "name": "rESTfulCardsPut", "summary": "Updates an existing card.", "description": "Use this card format for card update:\r\n \r\n {\r\n \"card_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000004463\"\r\n },\r\n \"name\": \"3Com 3C200500\",\r\n \"peak_power\": 200,\r\n \"weight\": 37,\r\n \"status\": \"offline\"\r\n }", "input": [ { "name": "id", "type": "number", "info": "Card id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated card.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCardsPut" }, "task": true }, { "name": "rESTfulCardsDelete", "summary": "Deletes a card.", "description": "Deleted card is replaced by a slot.", "input": [ { "name": "id", "type": "number", "info": "Card id.: 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": "/rESTfulCardsDelete" }, "task": true }, { "name": "rESTfulPortsGet", "summary": "Gets the ports collection.", "description": "Gets the ports collection.", "input": [ { "name": "typeGroup", "type": "string", "info": "Parent node type group: either \"devices\" or \"cards\".: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "nodeId", "type": "number", "info": "Parent node (device or card) id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulPortsGet" }, "task": true }, { "name": "rESTfulPortsGetById", "summary": "Gets the port.", "description": "Port id example: 23000000000123", "input": [ { "name": "typeGroup", "type": "string", "info": "Parent node type group: either \"devices\" or \"cards\".: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "nodeId", "type": "number", "info": "Parent node (device or card) id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Port id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "port_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_property_values": { "type": "object", "properties": { "href": { "type": "string" } } }, "links": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulPortsGetById" }, "task": true }, { "name": "getWapiV1Ports", "summary": "Gets the ports collection with no relation to a specific device or card.", "description": "This collection is useful when direct access to ports is required.\r\n For example, to search a port by its name and value when a parent device or card is unknown.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1Ports" }, "task": true }, { "name": "rESTfulLinksGet", "summary": "Gets the collection of links linked to a specific port.", "description": "Gets the collection of links linked to a specific port.", "input": [ { "name": "typeGroup", "type": "string", "info": "Port's parent node type: 'device' or 'card'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "nodeId", "type": "number", "info": "Port's parent node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Port's id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinksGet" }, "task": true }, { "name": "getWapiV1Links", "summary": "Gets the links collection.", "description": "Gets the links collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1Links" }, "task": true }, { "name": "rESTfulLinksPut", "summary": "Updates an existing link.", "description": "Use this format for link update:\r\n \r\n {\r\n \"name\": \"New Name\",\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated link.: {\"name\": \"string\", \"link_type\": {\"href\": \"string\"}, \"from_node\": {\"href\": \"string\"}, \"to_node\": {\"href\": \"string\"}, \"link_property_values\": {\"href\": \"string\"}, \"vis_links\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "from_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "to_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_property_values": { "type": "object", "properties": { "href": { "type": "string" } } }, "vis_links": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinksPut" }, "task": true }, { "name": "rESTfulLinksPost", "summary": "Creates a link.", "description": "Use this format for link creation:\r\n \r\n {\r\n \"name\": \"Link Name\",\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New link.: {\"name\": \"string\", \"link_type\": {\"href\": \"string\"}, \"from_node\": {\"href\": \"string\"}, \"to_node\": {\"href\": \"string\"}, \"link_property_values\": {\"href\": \"string\"}, \"vis_links\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "from_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "to_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_property_values": { "type": "object", "properties": { "href": { "type": "string" } } }, "vis_links": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinksPost" }, "task": true }, { "name": "rESTfulLinksGetById", "summary": "Gets the link.", "description": "Link id example: 25000000000123", "input": [ { "name": "id", "type": "number", "info": "Link id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "from_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "to_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_property_values": { "type": "object", "properties": { "href": { "type": "string" } } }, "vis_links": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinksGetById" }, "task": true }, { "name": "putWapiV1LinksId", "summary": "Updates an existing link.", "description": "Use this format for link update:\r\n \r\n {\r\n \"name\": \"New Name\",\r\n \"link_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_types/27000000000123\"\r\n },\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Link id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated link.: {\"name\": \"string\", \"link_type\": {\"href\": \"string\"}, \"from_node\": {\"href\": \"string\"}, \"to_node\": {\"href\": \"string\"}, \"link_property_values\": {\"href\": \"string\"}, \"vis_links\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "from_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "to_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_property_values": { "type": "object", "properties": { "href": { "type": "string" } } }, "vis_links": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1LinksId" }, "task": true }, { "name": "rESTfulLinksDelete", "summary": "Deletes a link.", "description": "Deletes a link.", "input": [ { "name": "id", "type": "number", "info": "Link id.: 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": "/rESTfulLinksDelete" }, "task": true }, { "name": "rESTfulSlotsGet", "summary": "Gets the slots collection.", "description": "Gets the slots collection.", "input": [ { "name": "typeGroup", "type": "string", "info": "Parent node type group: either \"devices\" or \"cards\".: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "nodeId", "type": "number", "info": "Parent node (device or card) id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotsGet" }, "task": true }, { "name": "rESTfulSlotsGetById", "summary": "Gets the slot.", "description": "Slot id example: 24000000000123", "input": [ { "name": "typeGroup", "type": "string", "info": "Parent node type group: either \"devices\" or \"cards\".: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "nodeId", "type": "number", "info": "Parent node (device or card) id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Slot id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "base_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotsGetById" }, "task": true }, { "name": "rESTfulSlotsPost", "summary": "Transforms the slot to the card (installs the card into the slot).", "description": "The slot disappears from Slots collection after card insertion. \r\n \r\n name parameter renames the slot if set, a new card uses the slot's name. \r\n Use this node format for new card creation:\r\n \r\n {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/cards/24000000000123\"\r\n \"card_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000004463\"\r\n },\r\n \"name\": \"3Com 3C200500\",\r\n ...(description truncated)", "input": [ { "name": "typeGroup", "type": "string", "info": "Parent node type group: either \"devices\" or \"cards\".: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "nodeId", "type": "number", "info": "Parent node (device or card) id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Slot id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "New card.: {\"parent\": {\"href\": \"string\"}, \"name\": \"string\", \"base_node\": {\"href\": \"string\"}, \"slot_representation\": {\"href\": \"string\"}, \"card_type\": {\"href\": \"string\"}, \"peak_power\": 123, \"weight\": 123, \"status\": \"string\", \"cards\": {\"href\": \"string\"}, \"slots\": {\"href\": \"string\"}, \"ports\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "base_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "card_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "peak_power": { "type": "number" }, "weight": { "type": "number" }, "status": { "type": "string" }, "cards": { "type": "object", "properties": { "href": { "type": "string" } } }, "slots": { "type": "object", "properties": { "href": { "type": "string" } } }, "ports": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotsPost" }, "task": true }, { "name": "getWapiV1Slots", "summary": "Gets the slots collection with no relation to a specific device or card.", "description": "This collection is useful when direct access to slots is required.\r\n For example, to search a slot by its name and value when a parent device or card is unknown.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1Slots" }, "task": true }, { "name": "rESTfulPortRepresentationsGet", "summary": "Gets the port representations collection for a type.", "description": "Gets the port representations collection for a type.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulPortRepresentationsGet" }, "task": true }, { "name": "rESTfulPortRepresentationsPost", "summary": "Creates an new card or device port representation.", "description": "Use this card type's port representation format for port type's port representation creation:\r\n \r\n {\r\n }", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "body", "type": "object", "info": "New card type's port representation body.: {\"parent_type\": {\"href\": \"string\"}, \"name\": \"string\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"angle\": 123, \"anchor_point_x\": 123, \"anchor_point_y\": 123, \"ref_x\": 123, \"ref_y\": 123, \"ref_width\": 123, \"ref_height\": 123, \"ref_angle\": 123, \"ref_anchor_point_x\": 123, \"ref_anchor_point_y\": 123, \"bendpoint_path\": \"string\", \"is_hidden\": \"boolean\", \"port_fields\": {\"href\": \"string\"}, \"node_type\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "anchor_point_x": { "type": "number" }, "anchor_point_y": { "type": "number" }, "ref_x": { "type": "number" }, "ref_y": { "type": "number" }, "ref_width": { "type": "number" }, "ref_height": { "type": "number" }, "ref_angle": { "type": "integer" }, "ref_anchor_point_x": { "type": "number" }, "ref_anchor_point_y": { "type": "number" }, "bendpoint_path": { "type": "string" }, "is_hidden": { "type": "boolean" }, "port_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulPortRepresentationsPost" }, "task": true }, { "name": "rESTfulPortRepresentationsGetById", "summary": "Gets the port representation belonging to the card or device type.", "description": "Gets the port representation belonging to the card or device type.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Port representation id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "anchor_point_x": { "type": "number" }, "anchor_point_y": { "type": "number" }, "ref_x": { "type": "number" }, "ref_y": { "type": "number" }, "ref_width": { "type": "number" }, "ref_height": { "type": "number" }, "ref_angle": { "type": "integer" }, "ref_anchor_point_x": { "type": "number" }, "ref_anchor_point_y": { "type": "number" }, "bendpoint_path": { "type": "string" }, "is_hidden": { "type": "boolean" }, "port_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulPortRepresentationsGetById" }, "task": true }, { "name": "rESTfulPortRepresentationsPut", "summary": "Update a card type's port representation.", "description": "Use this port representation format for port representation update:\r\n \r\n {\r\n }", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Parent type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Port representation id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Card type's port representation body with updated data.: {\"parent_type\": {\"href\": \"string\"}, \"name\": \"string\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"angle\": 123, \"anchor_point_x\": 123, \"anchor_point_y\": 123, \"ref_x\": 123, \"ref_y\": 123, \"ref_width\": 123, \"ref_height\": 123, \"ref_angle\": 123, \"ref_anchor_point_x\": 123, \"ref_anchor_point_y\": 123, \"bendpoint_path\": \"string\", \"is_hidden\": \"boolean\", \"port_fields\": {\"href\": \"string\"}, \"node_type\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "anchor_point_x": { "type": "number" }, "anchor_point_y": { "type": "number" }, "ref_x": { "type": "number" }, "ref_y": { "type": "number" }, "ref_width": { "type": "number" }, "ref_height": { "type": "number" }, "ref_angle": { "type": "integer" }, "ref_anchor_point_x": { "type": "number" }, "ref_anchor_point_y": { "type": "number" }, "bendpoint_path": { "type": "string" }, "is_hidden": { "type": "boolean" }, "port_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulPortRepresentationsPut" }, "task": true }, { "name": "rESTfulPortRepresentationsDelete", "summary": "Deletes the card type's port representation.", "description": "Deletes the card type's port representation.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Port representation id.: 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": "/rESTfulPortRepresentationsDelete" }, "task": true }, { "name": "getWapiV1PortRepresentations", "summary": "Gets the port representations collection with no relation to a specific a type.", "description": "This collection is useful when direct access to port representations is needed. For example,\r\n to find ports of certain capacity.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1PortRepresentations" }, "task": true }, { "name": "putWapiV1PortRepresentations", "summary": "Update a card type's port representation.", "description": "Use this port representation format for port representation update:\r\n \r\n {\r\n }", "input": [ { "name": "body", "type": "object", "info": "Card type's port representation body with updated data.: {\"parent_type\": {\"href\": \"string\"}, \"name\": \"string\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"angle\": 123, \"anchor_point_x\": 123, \"anchor_point_y\": 123, \"ref_x\": 123, \"ref_y\": 123, \"ref_width\": 123, \"ref_height\": 123, \"ref_angle\": 123, \"ref_anchor_point_x\": 123, \"ref_anchor_point_y\": 123, \"bendpoint_path\": \"string\", \"is_hidden\": \"boolean\", \"port_fields\": {\"href\": \"string\"}, \"node_type\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "anchor_point_x": { "type": "number" }, "anchor_point_y": { "type": "number" }, "ref_x": { "type": "number" }, "ref_y": { "type": "number" }, "ref_width": { "type": "number" }, "ref_height": { "type": "number" }, "ref_angle": { "type": "integer" }, "ref_anchor_point_x": { "type": "number" }, "ref_anchor_point_y": { "type": "number" }, "bendpoint_path": { "type": "string" }, "is_hidden": { "type": "boolean" }, "port_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1PortRepresentations" }, "task": true }, { "name": "postWapiV1PortRepresentations", "summary": "Creates an new card type's port representation.", "description": "Use this card type's port representation format for card type's port representation creation:\r\n \r\n {\r\n }", "input": [ { "name": "body", "type": "object", "info": "New card type's port representation body.: {\"parent_type\": {\"href\": \"string\"}, \"name\": \"string\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"angle\": 123, \"anchor_point_x\": 123, \"anchor_point_y\": 123, \"ref_x\": 123, \"ref_y\": 123, \"ref_width\": 123, \"ref_height\": 123, \"ref_angle\": 123, \"ref_anchor_point_x\": 123, \"ref_anchor_point_y\": 123, \"bendpoint_path\": \"string\", \"is_hidden\": \"boolean\", \"port_fields\": {\"href\": \"string\"}, \"node_type\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "anchor_point_x": { "type": "number" }, "anchor_point_y": { "type": "number" }, "ref_x": { "type": "number" }, "ref_y": { "type": "number" }, "ref_width": { "type": "number" }, "ref_height": { "type": "number" }, "ref_angle": { "type": "integer" }, "ref_anchor_point_x": { "type": "number" }, "ref_anchor_point_y": { "type": "number" }, "bendpoint_path": { "type": "string" }, "is_hidden": { "type": "boolean" }, "port_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1PortRepresentations" }, "task": true }, { "name": "getWapiV1PortRepresentationsId", "summary": "Gets the port representation belonging to the card type.", "description": "Card type id example: 26000000014512", "input": [ { "name": "id", "type": "number", "info": "Port representation id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1PortRepresentationsId" }, "task": true }, { "name": "rESTfulPortFieldsGet", "summary": "Gets the port fields collection for a port representation.", "description": "Gets the port fields collection for a port representation.", "input": [ { "name": "portRepresentationId", "type": "number", "info": "Host port representation id.: 123", "required": true, "schema": { "title": "portRepresentationId", "type": "number" } }, { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulPortFieldsGet" }, "task": true }, { "name": "rESTfulPortFieldsGetById", "summary": "Gets the port field by id.", "description": "Gets the port field by id.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "portRepresentationId", "type": "number", "info": "Host port representation id.: 123", "required": true, "schema": { "title": "portRepresentationId", "type": "number" } }, { "name": "id", "type": "number", "info": "Port field id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_port_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_reference_port": { "type": "boolean" }, "node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "value": { "type": "string" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulPortFieldsGetById" }, "task": true }, { "name": "getWapiV1PortFields", "summary": "Gets the general port fields collection.", "description": "This collection is useful when direct access to port fields is needed.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1PortFields" }, "task": true }, { "name": "getWapiV1PortFieldsId", "summary": "Gets the port field by id.", "description": "Gets the port field by id.", "input": [ { "name": "id", "type": "number", "info": "Port field id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1PortFieldsId" }, "task": true }, { "name": "rESTfulSlotRepresentationsGet", "summary": "Gets the slot eepresentations collection for a type.", "description": "Gets the slot eepresentations collection for a type.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotRepresentationsGet" }, "task": true }, { "name": "rESTfulSlotRepresentationsPost", "summary": "Creates an new card or device slot representation.", "description": "Use this slot representation format for slot representation creation:\r\n \r\n {\r\n \"name\": \"NM\",\r\n \"x\": 9.0,\r\n \"y\": 327.0,\r\n \"width\": 402.0,\r\n \"height\": 94.0,\r\n \"angle\": 0\r\n }", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "body", "type": "object", "info": "New slot representation body.: {\"parent_type\": {\"href\": \"string\"}, \"name\": \"string\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"angle\": 123, \"slot_mapping\": {\"href\": \"string\"}, \"slot_fields\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "slot_mapping": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotRepresentationsPost" }, "task": true }, { "name": "rESTfulSlotRepresentationsGetById", "summary": "Gets the slot representation belonging to the card or device type.", "description": "Gets the slot representation belonging to the card or device type.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Slot representation id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "slot_mapping": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotRepresentationsGetById" }, "task": true }, { "name": "rESTfulSlotRepresentationsPut", "summary": "Update a card type's slot representation.", "description": "Use this slot representation format for slot representation update:\r\n \r\n {\r\n \"name\": \"NM\",\r\n \"x\": 9.0,\r\n \"y\": 327.0,\r\n \"width\": 402.0,\r\n \"height\": 94.0,\r\n \"angle\": 0\r\n }", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Parent type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Slot representation id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Slot representation body with updated data.: {\"parent_type\": {\"href\": \"string\"}, \"name\": \"string\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"angle\": 123, \"slot_mapping\": {\"href\": \"string\"}, \"slot_fields\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "slot_mapping": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotRepresentationsPut" }, "task": true }, { "name": "rESTfulSlotRepresentationsDelete", "summary": "Deletes the card type's slot representation.", "description": "Deletes the card type's slot representation.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Slot representation id.: 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": "/rESTfulSlotRepresentationsDelete" }, "task": true }, { "name": "getWapiV1SlotRepresentations", "summary": "Gets the slot representations collection with no relation to a specific a type.", "description": "This collection is useful when direct access to slot representations is needed.\r\n For example, to find slots of certain capacity.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1SlotRepresentations" }, "task": true }, { "name": "putWapiV1SlotRepresentations", "summary": "Update a card type's slot representation.", "description": "Use this slot representation format for slot representation update:\r\n \r\n {\r\n \"name\": \"NM\",\r\n \"x\": 9.0,\r\n \"y\": 327.0,\r\n \"width\": 402.0,\r\n \"height\": 94.0,\r\n \"angle\": 0,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/device_types/26000000002684/slot_representations/2744\"\r\n }", "input": [ { "name": "body", "type": "object", "info": "Slot representation body with updated data.: {\"parent_type\": {\"href\": \"string\"}, \"name\": \"string\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"angle\": 123, \"slot_mapping\": {\"href\": \"string\"}, \"slot_fields\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "slot_mapping": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1SlotRepresentations" }, "task": true }, { "name": "postWapiV1SlotRepresentations", "summary": "Creates an new card type's slot representation.", "description": "Use this card type's slot representation format for slot representation creation:\r\n \r\n {\r\n \"parent_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/v1/device_types/26000000002684\"\r\n },\r\n \"name\": \"NM\",\r\n \"x\": 9.0,\r\n \"y\": 327.0,\r\n \"width\": 402.0,\r\n \"height\": 94.0,\r\n \"angle\": 0\r\n }", "input": [ { "name": "body", "type": "object", "info": "New slot representation body.: {\"parent_type\": {\"href\": \"string\"}, \"name\": \"string\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"angle\": 123, \"slot_mapping\": {\"href\": \"string\"}, \"slot_fields\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "angle": { "type": "integer" }, "slot_mapping": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1SlotRepresentations" }, "task": true }, { "name": "getWapiV1SlotRepresentationsId", "summary": "Gets the slot representation belonging to the card type.", "description": "Card type id example: 26000000014512", "input": [ { "name": "id", "type": "number", "info": "Slot representation id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1SlotRepresentationsId" }, "task": true }, { "name": "rESTfulSlotFieldsGet", "summary": "Gets the slot fields collection for a slot representation.", "description": "Gets the slot fields collection for a slot representation.", "input": [ { "name": "slotRepresentationId", "type": "number", "info": "Host slot representation id.: 123", "required": true, "schema": { "title": "slotRepresentationId", "type": "number" } }, { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotFieldsGet" }, "task": true }, { "name": "rESTfulSlotFieldsGetById", "summary": "Gets the slot field by id.", "description": "Gets the slot field by id.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "slotRepresentationId", "type": "number", "info": "Host slot representation id.: 123", "required": true, "schema": { "title": "slotRepresentationId", "type": "number" } }, { "name": "id", "type": "number", "info": "Slot field id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_slot_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "value": { "type": "string" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotFieldsGetById" }, "task": true }, { "name": "getWapiV1SlotFields", "summary": "Gets the general slot fields collection.", "description": "This collection is useful when direct access to slot fields is needed.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1SlotFields" }, "task": true }, { "name": "getWapiV1SlotFieldsId", "summary": "Gets the slot field by id.", "description": "Gets the slot field by id.", "input": [ { "name": "id", "type": "number", "info": "Slot field id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1SlotFieldsId" }, "task": true }, { "name": "rESTfulSlotMappingGet", "summary": "Gets the slot mappings collection for a slot representation.", "description": "Gets the slot mappings collection for a slot representation.", "input": [ { "name": "slotRepresentationId", "type": "number", "info": "Host slot representation id.: 123", "required": true, "schema": { "title": "slotRepresentationId", "type": "number" } }, { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotMappingGet" }, "task": true }, { "name": "rESTfulSlotMappingPost", "summary": "Creates an new card or device slot mapping.", "description": "Use this slot mapping format for slot mapping creation:\r\n \r\n {\r\n \"card_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000004993\"\r\n }\r\n }", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "slotRepresentationId", "type": "number", "info": "Host slot representation id.: 123", "required": true, "schema": { "title": "slotRepresentationId", "type": "number" } }, { "name": "body", "type": "object", "info": "New slot mapping body.: {\"slot_representation\": {\"href\": \"string\"}, \"card_type\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "slot_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "card_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotMappingPost" }, "task": true }, { "name": "rESTfulSlotMappingGetById", "summary": "Gets the slot mapping by id.", "description": "Gets the slot mapping by id.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "slotRepresentationId", "type": "number", "info": "Host slot representation id.: 123", "required": true, "schema": { "title": "slotRepresentationId", "type": "number" } }, { "name": "id", "type": "number", "info": "Slot mapping id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "slot_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "card_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSlotMappingGetById" }, "task": true }, { "name": "rESTfulSlotMappingDelete", "summary": "Deletes the card type's slot mapping.", "description": "Deletes the card type's slot mapping.", "input": [ { "name": "typeGroup", "type": "string", "info": "Type group: 'card_types' or 'device_types'.: string", "required": true, "schema": { "title": "typeGroup", "type": "string" } }, { "name": "typeId", "type": "number", "info": "Host type id.: 123", "required": true, "schema": { "title": "typeId", "type": "number" } }, { "name": "slotRepresentationId", "type": "number", "info": "Host slot representation id.: 123", "required": true, "schema": { "title": "slotRepresentationId", "type": "number" } }, { "name": "id", "type": "number", "info": "Slot mapping id.: 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": "/rESTfulSlotMappingDelete" }, "task": true }, { "name": "getWapiV1SlotMapping", "summary": "Gets the general slot mappings collection.", "description": "This collection is useful when direct access to slot mappings is needed.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1SlotMapping" }, "task": true }, { "name": "postWapiV1SlotMapping", "summary": "Creates an new slot mapping.", "description": "Use this card type's slot mapping format for slot mapping creation:\r\n \r\n {\r\n \"slot_representation\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/device_types/26000000002684/slot_representations/2745\"\r\n },\r\n \"card_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/card_types/26000000004993\"\r\n }\r\n }", "input": [ { "name": "body", "type": "object", "info": "New slot mapping body.: {\"slot_representation\": {\"href\": \"string\"}, \"card_type\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "slot_representation": { "type": "object", "properties": { "href": { "type": "string" } } }, "card_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1SlotMapping" }, "task": true }, { "name": "getWapiV1SlotMappingId", "summary": "Gets the slot mapping by id.", "description": "Gets the slot mapping by id.", "input": [ { "name": "id", "type": "number", "info": "Slot mapping id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1SlotMappingId" }, "task": true }, { "name": "rESTfulCardTypesGet", "summary": "Gets the card types collection.", "description": "Gets the card types collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCardTypesGet" }, "task": true }, { "name": "rESTfulCardTypesPut", "summary": "Updates an existing card type.", "description": "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\n The type group of the card type cannot be changed. \r\n When altering the name parameter (renaming the card type) the new name must be\r\n unique. \r\n When changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated card type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCardTypesPut" }, "task": true }, { "name": "rESTfulCardTypesPost", "summary": "Creates an new card type.", "description": "Use this card types format for card type create:\r\n \r\n {\r\n \"base_node_type\": {\r\n \"image\": \"MyCard.jpg\",\r\n \"is_favorite\": true,\r\n \"template\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/wapi/v1/nodes/24000000000123\"\r\n },\r\n },\r\n \"name\": \"My card type\",\r\n \"background\": null,\r\n \"peak_power\": 200.0,\r\n \"weight\":...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New card type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCardTypesPost" }, "task": true }, { "name": "rESTfulCardTypesGetById", "summary": "Gets the card type.", "description": "Card type id example: 26000000000123", "input": [ { "name": "id", "type": "number", "info": "Card type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "base_node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "background": { "type": "string" }, "peak_power": { "type": "number" }, "weight": { "type": "number" }, "physical_height": { "type": "number" }, "physical_width": { "type": "number" }, "vendor": { "type": "object", "properties": { "href": { "type": "string" } } }, "port_representations": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_representations": { "type": "object", "properties": { "href": { "type": "string" } } }, "mapped_to": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCardTypesGetById" }, "task": true }, { "name": "putWapiV1CardTypesId", "summary": "Updates an existing card type.", "description": "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\n The type group of the card type cannot be changed. \r\n When altering the name parameter (renaming the card type) the new name must be\r\n unique. \r\n When changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Card type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated card type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1CardTypesId" }, "task": true }, { "name": "rESTfulCardTypesDelete", "summary": "Deletes a card type.", "description": "Only types without associated cards can be deleted.", "input": [ { "name": "id", "type": "number", "info": "Card type id.: 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": "/rESTfulCardTypesDelete" }, "task": true }, { "name": "rESTfulCircuitPropertiesGet", "summary": "Gets the circuit properties collection.", "description": "Gets the circuit properties collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitPropertiesGet" }, "task": true }, { "name": "rESTfulCircuitPropertiesPut", "summary": "Updates an existing circuit property.", "description": "When altering the name parameter (renaming the circuit property) the new name\r\n must be unique. Only non-system properties can be renamed. \r\n System status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name. \r\n \r\n Use this circuit properties format for circuit override update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"show_in_acra\": true,\r\n \"href\": \"http://172.30.1.11...(description truncated)", "input": [ { "name": "property", "type": "object", "info": "Updated circuit property.: {\"name\": \"string\", \"is_system\": \"boolean\", \"show_in_acra\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_system": { "type": "boolean" }, "show_in_acra": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitPropertiesPut" }, "task": true }, { "name": "rESTfulCircuitPropertiesPost", "summary": "Creates a new circuit property.", "description": "Use this circuit property format for circuit property update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"show_in_acra\": true\r\n }", "input": [ { "name": "circuitProperty", "type": "object", "info": "New circuit property.: {\"name\": \"string\", \"is_system\": \"boolean\", \"show_in_acra\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_system": { "type": "boolean" }, "show_in_acra": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitPropertiesPost" }, "task": true }, { "name": "rESTfulCircuitPropertiesGetById", "summary": "Gets a circuit property.", "description": "Circuit property id example: 43000000000076", "input": [ { "name": "id", "type": "number", "info": "Circuit property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_system": { "type": "boolean" }, "show_in_acra": { "type": "boolean" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitPropertiesGetById" }, "task": true }, { "name": "rESTfulCircuitPropertiesDelete", "summary": "Deletes a circuit property.", "description": "Only non-system circuit properties can be deleted.", "input": [ { "name": "id", "type": "number", "info": "Circuit property id.: 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": "/rESTfulCircuitPropertiesDelete" }, "task": true }, { "name": "rESTfulCircuitPropertyValuesGet", "summary": "Gets the circuit property values collection with no relation to a specific circuit.", "description": "Gets the circuit property values collection with no relation to a specific circuit.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitPropertyValuesGet" }, "task": true }, { "name": "getWapiV1CircuitsCircuitIdCircuitPropertyValues", "summary": "Gets the circuit property values collection.", "description": "Gets the circuit property values collection.", "input": [ { "name": "circuitId", "type": "number", "info": "Parent circuit id.: 123", "required": true, "schema": { "title": "circuitId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1CircuitsCircuitIdCircuitPropertyValues" }, "task": true }, { "name": "rESTfulCircuitPropertyValuesPut", "summary": "Updates an existing circuit property value.", "description": "Use this circuit property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/circuits/37000000010516/circuit_property_values/44000000013595\"\r\n }", "input": [ { "name": "circuitId", "type": "number", "info": "Parent circuit id.: 123", "required": true, "schema": { "title": "circuitId", "type": "number" } }, { "name": "circuitPropertyValue", "type": "object", "info": "Updated circuit property value id.: {\"name\": \"string\", \"parent_circuit\": {\"href\": \"string\"}, \"circuit_property\": {\"href\": \"string\"}, \"value\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_circuit": { "type": "object", "properties": { "href": { "type": "string" } } }, "circuit_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitPropertyValuesPut" }, "task": true }, { "name": "rESTfulCircuitPropertyValuesGetById", "summary": "Gets the circuit property value.", "description": "Circuit id example: 37000000000123, Circuit property value id example: 44000000013595.", "input": [ { "name": "circuitId", "type": "number", "info": "Parent circuit id.: 123", "required": true, "schema": { "title": "circuitId", "type": "number" } }, { "name": "id", "type": "number", "info": "Circuit property value id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_circuit": { "type": "object", "properties": { "href": { "type": "string" } } }, "circuit_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitPropertyValuesGetById" }, "task": true }, { "name": "rESTfulCircuitPropertyValuesInitAbsentValues", "summary": "Creates absent circuit property values.", "description": "Creates absent circuit property values.", "input": [ { "name": "circuitId", "type": "number", "info": "User id.: 123", "required": true, "schema": { "title": "circuitId", "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": "/rESTfulCircuitPropertyValuesInitAbsentValues" }, "task": true }, { "name": "rESTfulCircuitsGet", "summary": "Gets the circuits collection.", "description": "Gets the circuits collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitsGet" }, "task": true }, { "name": "rESTfulCircuitsPost", "summary": "Creates a circuit.", "description": "Examples:\r\n \r\n Use this data format for creation of new Edge-to-edge circuit:\r\n \r\n {\r\n \"name\": \"New circuit name\",\r\n \"from_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000139248\"\r\n },\r\n \"to_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/cards/24000000139327\"\r\n },\r\n \"patch_type\": {\r\n \"href\"...(description truncated)", "input": [ { "name": "addCircuitData", "type": "object", "info": "Data for new circuit.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitsPost" }, "task": true }, { "name": "rESTfulCircuitsGetById", "summary": "Gets the circuit.", "description": "Circuit id example: 37000000000123", "input": [ { "name": "id", "type": "number", "info": "Circuit id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "from_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "to_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "circuit_property_values": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulCircuitsGetById" }, "task": true }, { "name": "rESTfulCircuitsDelete", "summary": "Deletes a circuit.", "description": "Deletes a circuit.", "input": [ { "name": "id", "type": "number", "info": "Circuit id.: 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": "/rESTfulCircuitsDelete" }, "task": true }, { "name": "rESTfulDeviceTypesGet", "summary": "Gets the device types collection.", "description": "Gets the device types collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDeviceTypesGet" }, "task": true }, { "name": "rESTfulDeviceTypesPut", "summary": "Updates an existing device type.", "description": "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\n The type group of the device type cannot be changed. \r\n When altering the name parameter (renaming the device type) the new name must be\r\n unique. \r\n When changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated device type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDeviceTypesPut" }, "task": true }, { "name": "rESTfulDeviceTypesPost", "summary": "Creates an new device type.", "description": "Use this device types format for device type create:\r\n \r\n {\r\n \"system_object_id\": \"1.2.3.4.5.6.7.8.9.10\",\r\n \"base_node_type\": {\r\n \"image\": \"MyDevice.jpg\",\r\n \"is_favorite\": true,\r\n \"template\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/wapi/v1/nodes/24000000000123\"\r\n },\r\n },\r\n \"name\": \"My device type\",\r\n \"background\": ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New device type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDeviceTypesPost" }, "task": true }, { "name": "rESTfulDeviceTypesGetById", "summary": "Gets the device type.", "description": "Device type id example: 26000000000123", "input": [ { "name": "id", "type": "number", "info": "Device type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "system_object_id": { "type": "string" }, "in_stock": { "type": "integer" }, "base_node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "background": { "type": "string" }, "peak_power": { "type": "number" }, "weight": { "type": "number" }, "physical_height": { "type": "number" }, "physical_width": { "type": "number" }, "vendor": { "type": "object", "properties": { "href": { "type": "string" } } }, "port_representations": { "type": "object", "properties": { "href": { "type": "string" } } }, "slot_representations": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDeviceTypesGetById" }, "task": true }, { "name": "putWapiV1DeviceTypesId", "summary": "Updates an existing device type.", "description": "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\n The type group of the device type cannot be changed. \r\n When altering the name parameter (renaming the device type) the new name must be\r\n unique. \r\n When changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Device type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated device type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1DeviceTypesId" }, "task": true }, { "name": "rESTfulDeviceTypesDelete", "summary": "Deletes a device type.", "description": "Only types without associated devices can be deleted.", "input": [ { "name": "id", "type": "number", "info": "Device type id.: 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": "/rESTfulDeviceTypesDelete" }, "task": true }, { "name": "rESTfulDevicesGet", "summary": "Gets the devices collection.", "description": "Gets the devices collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDevicesGet" }, "task": true }, { "name": "rESTfulDevicesPost", "summary": "Creates a device.", "description": "Use this node format for new device creation:\r\n \r\n Create and mount to a rack container:\r\n \r\n {\r\n \"name\": \"Cisco WS-C2960-24-S\",\r\n \"parent_rack_container\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/racks/24000000010327/containers/38\"\r\n },\r\n \"device_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/device_types/26000000003399\"\r\n },\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New device.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDevicesPost" }, "task": true }, { "name": "rESTfulDevicesGetById", "summary": "Gets the device.", "description": "Device id example: 24000000000123", "input": [ { "name": "id", "type": "number", "info": "Device id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "base_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "parent_rack_container": { "type": "object", "properties": { "href": { "type": "string" } } }, "device_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "peak_power": { "type": "number" }, "weight": { "type": "number" }, "status": { "type": "string" }, "container_position": { "type": "number" }, "rack_units_occupied": { "type": "number" }, "cards": { "type": "object", "properties": { "href": { "type": "string" } } }, "slots": { "type": "object", "properties": { "href": { "type": "string" } } }, "ports": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDevicesGetById" }, "task": true }, { "name": "rESTfulDevicesPut", "summary": "Updates an existing device.", "description": "Use this device format for device update:\r\n \r\n Remount and update properties:\r\n \r\n {\r\n \"parent_rack_container\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/racks/24000000010327/containers/39\"\r\n },\r\n \"container_position\": 29,\r\n \"name\": \"My Device\",\r\n \"peak_power\": 200,\r\n \"weight\": 37,\r\n \"status\": \"online\"\r\n \"href\": \"http...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Device id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated device.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDevicesPut" }, "task": true }, { "name": "rESTfulDevicesDelete", "summary": "Deletes a device.", "description": "Deletes a device.", "input": [ { "name": "id", "type": "number", "info": "Device id.: 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": "/rESTfulDevicesDelete" }, "task": true }, { "name": "getWapiV1RacksRackIdContainersContainerIdMountedDevices", "summary": "Gets the collection of devices mounted to the rack container.", "description": "Gets the collection of devices mounted to the rack container.", "input": [ { "name": "rackId", "type": "number", "info": "Parent rack id.: 123", "required": true, "schema": { "title": "rackId", "type": "number" } }, { "name": "containerId", "type": "number", "info": "Rack container id.: 123", "required": true, "schema": { "title": "containerId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1RacksRackIdContainersContainerIdMountedDevices" }, "task": true }, { "name": "rESTfulDevicesMountDevice", "summary": "Mounts the device into the rack container.", "description": "Use this device format for device mounting:\r\n \r\n {\r\n \"container_position\": 24,\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/devices/24000000010430\"\r\n }", "input": [ { "name": "rackId", "type": "number", "info": "Parent rack id.: 123", "required": true, "schema": { "title": "rackId", "type": "number" } }, { "name": "containerId", "type": "number", "info": "Rack container id.: 123", "required": true, "schema": { "title": "containerId", "type": "number" } }, { "name": "body", "type": "object", "info": "The device to mount.: {\"base_node\": {\"href\": \"string\"}, \"parent_rack_container\": {\"href\": \"string\"}, \"device_type\": {\"href\": \"string\"}, \"name\": \"string\", \"peak_power\": 123, \"weight\": 123, \"status\": \"string\", \"container_position\": 123, \"rack_units_occupied\": 123, \"cards\": {\"href\": \"string\"}, \"slots\": {\"href\": \"string\"}, \"ports\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "base_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "parent_rack_container": { "type": "object", "properties": { "href": { "type": "string" } } }, "device_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "peak_power": { "type": "number" }, "weight": { "type": "number" }, "status": { "type": "string" }, "container_position": { "type": "number" }, "rack_units_occupied": { "type": "number" }, "cards": { "type": "object", "properties": { "href": { "type": "string" } } }, "slots": { "type": "object", "properties": { "href": { "type": "string" } } }, "ports": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDevicesMountDevice" }, "task": true }, { "name": "rESTfulFreeTextGet", "summary": "Gets the free text objects collection.", "description": "Gets the free text objects collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulFreeTextGet" }, "task": true }, { "name": "rESTfulFreeTextPut", "summary": "Updates an existing free text object.", "description": "Use this free text object format:\r\n \r\n {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028499\"\r\n },\r\n \"master_free_text\": null,\r\n \"value\": \"My text\",\r\n \"displayed_value\": \"My text\",\r\n \"x\": 200,\r\n \"y\": 200,\r\n \"z_order\": 0,\r\n \"is_alias\": false,\r\n \"font_size\": 16,\r\n \"color...(description truncated)", "input": [ { "name": "freeText", "type": "object", "info": "Updated free text object.: {\"parent_diagram\": {\"href\": \"string\"}, \"creator\": {\"href\": \"string\"}, \"master_free_text\": {\"href\": \"string\"}, \"value\": \"string\", \"displayed_value\": \"string\", \"x\": 123, \"y\": 123, \"z_order\": 123, \"is_alias\": \"boolean\", \"font_size\": 123, \"color\": \"string\", \"background_color\": \"string\", \"justification\": 123, \"can_move\": \"boolean\", \"angle\": 123, \"is_displayed\": \"boolean\", \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underline\": \"boolean\", \"font_family\": \"string\", \"align\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "creator": { "type": "object", "properties": { "href": { "type": "string" } } }, "master_free_text": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "z_order": { "type": "integer" }, "is_alias": { "type": "boolean" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulFreeTextPut" }, "task": true }, { "name": "rESTfulFreeTextPost", "summary": "Creates a free text object.", "description": "Use this format for free text object creation:\r\n \r\n {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028499\"\r\n },\r\n \"value\": \"My text\",\r\n \"x\": 200,\r\n \"y\": 200,\r\n \"z_order\": 0,\r\n \"font_size\": 16,\r\n \"color\": \"#132312\",\r\n \"background_color\": \"#A00A01\",\r\n \"justification\": 0,\r\n ...(description truncated)", "input": [ { "name": "freeText", "type": "object", "info": "New free text object.: {\"parent_diagram\": {\"href\": \"string\"}, \"creator\": {\"href\": \"string\"}, \"master_free_text\": {\"href\": \"string\"}, \"value\": \"string\", \"displayed_value\": \"string\", \"x\": 123, \"y\": 123, \"z_order\": 123, \"is_alias\": \"boolean\", \"font_size\": 123, \"color\": \"string\", \"background_color\": \"string\", \"justification\": 123, \"can_move\": \"boolean\", \"angle\": 123, \"is_displayed\": \"boolean\", \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underline\": \"boolean\", \"font_family\": \"string\", \"align\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "creator": { "type": "object", "properties": { "href": { "type": "string" } } }, "master_free_text": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "z_order": { "type": "integer" }, "is_alias": { "type": "boolean" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulFreeTextPost" }, "task": true }, { "name": "rESTfulFreeTextGetById", "summary": "Gets the free text object.", "description": "Gets the free text object.", "input": [ { "name": "id", "type": "number", "info": "Free text object id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "creator": { "type": "object", "properties": { "href": { "type": "string" } } }, "master_free_text": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "z_order": { "type": "integer" }, "is_alias": { "type": "boolean" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulFreeTextGetById" }, "task": true }, { "name": "rESTfulFreeTextDelete", "summary": "Deletes a free text object.", "description": "Deletes a free text object.", "input": [ { "name": "id", "type": "number", "info": "Free text object id.: 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": "/rESTfulFreeTextDelete" }, "task": true }, { "name": "rESTfulFreeTextGetAliases", "summary": "Gets the collection of free text objct aliases.", "description": "Gets the collection of free text objct aliases.", "input": [ { "name": "masterFreeTextId", "type": "number", "info": "Id of a free text object to get aliases for.: 123", "required": true, "schema": { "title": "masterFreeTextId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulFreeTextGetAliases" }, "task": true }, { "name": "postWapiV1FreeTextMasterFreeTextIdAliases", "summary": "Creates a free text alias.", "description": "Use this format for new free text object creation:\r\n \r\n {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000001\"\r\n }\r\n }", "input": [ { "name": "masterFreeTextId", "type": "number", "info": "Master free text id.: 123", "required": true, "schema": { "title": "masterFreeTextId", "type": "number" } }, { "name": "freeText", "type": "object", "info": "New free text alias.: {\"parent_diagram\": {\"href\": \"string\"}, \"creator\": {\"href\": \"string\"}, \"master_free_text\": {\"href\": \"string\"}, \"value\": \"string\", \"displayed_value\": \"string\", \"x\": 123, \"y\": 123, \"z_order\": 123, \"is_alias\": \"boolean\", \"font_size\": 123, \"color\": \"string\", \"background_color\": \"string\", \"justification\": 123, \"can_move\": \"boolean\", \"angle\": 123, \"is_displayed\": \"boolean\", \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underline\": \"boolean\", \"font_family\": \"string\", \"align\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "creator": { "type": "object", "properties": { "href": { "type": "string" } } }, "master_free_text": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "z_order": { "type": "integer" }, "is_alias": { "type": "boolean" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1FreeTextMasterFreeTextIdAliases" }, "task": true }, { "name": "rESTfulGroupsGet", "summary": "Gets the user groups collection.", "description": "Gets the user groups collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulGroupsGet" }, "task": true }, { "name": "rESTfulGroupsPut", "summary": "Updates an existing user group.", "description": "System groups cannot be updated. A non-system group cannot be changed to a system\r\n group. \r\n When altering the Name parameter (renaming the group) the new name must be\r\n unique throughout groups. \r\n Use this group format for group update:\r\n \r\n {\r\n \"name\": \"My Group\",\r\n \"system\": false,\r\n \"role\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/roles/13000000000003\"\r\n }\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated user group.: {\"name\": \"string\", \"is_system\": \"boolean\", \"role\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_system": { "type": "boolean" }, "role": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulGroupsPut" }, "task": true }, { "name": "rESTfulGroupsPost", "summary": "Creates a user group.", "description": "Use this group format for new groups creation:\r\n \r\n {\r\n \"name\": \"New Group Example\",\r\n \"role\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/roles/13000000000003\"\r\n }\r\n }", "input": [ { "name": "group", "type": "object", "info": "New user group.: {\"name\": \"string\", \"is_system\": \"boolean\", \"role\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_system": { "type": "boolean" }, "role": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulGroupsPost" }, "task": true }, { "name": "rESTfulGroupsGetById", "summary": "Gets a user group.", "description": "User group id example: 12000000000003", "input": [ { "name": "id", "type": "number", "info": "User group id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_system": { "type": "boolean" }, "role": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulGroupsGetById" }, "task": true }, { "name": "putWapiV1GroupsId", "summary": "Updates an existing user group.", "description": "System groups cannot be updated. A non-system group cannot be changed to a system\r\n group. \r\n When altering the Name parameter (renaming the group) the new name must be\r\n unique throughout groups. \r\n Use this group format for group update:\r\n \r\n {\r\n \"name\": \"My Group\",\r\n \"system\": false,\r\n \"role\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/roles/13000000000003\"\r\n }\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "User group id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated user group.: {\"name\": \"string\", \"is_system\": \"boolean\", \"role\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_system": { "type": "boolean" }, "role": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1GroupsId" }, "task": true }, { "name": "rESTfulGroupsDelete", "summary": "Deletes a user group.", "description": "User group id example: 12000000000003. \r\n \r\n Only a non-system user group can be deleted. \r\n \r\n A user group with users cannot be deleted.", "input": [ { "name": "id", "type": "number", "info": "User group id.: 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": "/rESTfulGroupsDelete" }, "task": true }, { "name": "rESTfulHierarchyGet", "summary": "Gets the hierarchy.", "description": "Gets the hierarchy.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulHierarchyGet" }, "task": true }, { "name": "rESTfulHierarchyGetById", "summary": "Gets the hierarchy starting from the root element.", "description": "Gets the hierarchy starting from the root element.", "input": [ { "name": "id", "type": "number", "info": "Id of the root node of the hierarchy.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulHierarchyGetById" }, "task": true }, { "name": "rESTfulDeviceQueryImportImportDeviceQuery", "summary": "Imports the zipped device type query and creates the device type.", "description": "Use this C# code example as a reference for your client application:\r\n \r\n public static void ImportDeviceQuery(string zipFileFullPath)\r\n {\r\n // Create the query request with RestSharp API client library.\r\n // (see https://restsharp.dev/).\r\n \r\n var request = new RestRequest(\"import/device_type_query\", Method.POST);\r\n \r\n // Add file content for upload.\r\n request.AddFileByt...(description truncated)", "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": "/rESTfulDeviceQueryImportImportDeviceQuery" }, "task": true }, { "name": "rESTfulLinkCategoriesGet", "summary": "Gets the link categories collection.", "description": "Gets the link categories collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkCategoriesGet" }, "task": true }, { "name": "rESTfulLinkCategoriesPut", "summary": "Updates an existing link category.", "description": "When altering the name parameter (renaming the link category) the new name must\r\n be unique throughout all link categories. \r\n \r\n When changing the image, parameter the image file should already exist\r\n on the server. The same icon image can be used for different categories. Use an empty string\r\n to remove the icon image. \r\n Use this link categories format for link category update:\r\n \r\n {\r\n \"name\": \"My category\",\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated link category.: {\"parent_link_category\": {\"href\": \"string\"}, \"name\": \"string\", \"image\": \"string\", \"is_favorite\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_link_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "image": { "type": "string" }, "is_favorite": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkCategoriesPut" }, "task": true }, { "name": "rESTfulLinkCategoriesPost", "summary": "Creates a link category.", "description": "Use this link category format for new link categories creation:\r\n \r\n {\r\n \"name\": \"New category\",\r\n \"is_favorite\": true,\r\n \"parent_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/link_categories/32000000000001\"\r\n }\r\n }", "input": [ { "name": "body", "type": "object", "info": "New link category.: {\"parent_link_category\": {\"href\": \"string\"}, \"name\": \"string\", \"image\": \"string\", \"is_favorite\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_link_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "image": { "type": "string" }, "is_favorite": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkCategoriesPost" }, "task": true }, { "name": "rESTfulLinkCategoriesGetById", "summary": "Gets a link category.", "description": "Link category id example: 32000000000002", "input": [ { "name": "id", "type": "number", "info": "Link category id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_link_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "image": { "type": "string" }, "is_favorite": { "type": "boolean" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkCategoriesGetById" }, "task": true }, { "name": "putWapiV1LinkCategoriesId", "summary": "Updates an existing link category.", "description": "When altering the name parameter (renaming the link category) the new name must\r\n be unique throughout all link categories. \r\n \r\n When changing the image, parameter the image file should already exist\r\n on the server. The same icon image can be used for different categories. Use an empty string\r\n to remove the icon image. \r\n Use this link categories format for link category update:\r\n \r\n {\r\n \"name\": \"My category\",\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Link category id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated link category.: {\"parent_link_category\": {\"href\": \"string\"}, \"name\": \"string\", \"image\": \"string\", \"is_favorite\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_link_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "image": { "type": "string" }, "is_favorite": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1LinkCategoriesId" }, "task": true }, { "name": "rESTfulLinkCategoriesDelete", "summary": "Deletes a link category.", "description": "Link categories in use cannot be deleted.", "input": [ { "name": "id", "type": "number", "info": "Link category id.: 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": "/rESTfulLinkCategoriesDelete" }, "task": true }, { "name": "rESTfulLinkOverridesGet", "summary": "Gets the general link overrides collection.", "description": "Gets the general link overrides collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkOverridesGet" }, "task": true }, { "name": "rESTfulLinkOverridesPut", "summary": "Updates an existing link override.", "description": "As the general link overrides endpoint is used the updated resource is identified by\r\n its 'href' in the body. \r\n 'parent_link_type_property' cannot be changed. \r\n By altering the is_override parameter an override can be transformed into a list\r\n value (\"is_override\": false). \r\n Use this link categories format for link override update:\r\n \r\n {\r\n \"parent_link_type_property\": {\r\n \"href\": \"https://[netTerrain App Url]/wapi...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated link override.: {\"parent_link_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"rule\": 123, \"is_override\": \"boolean\", \"thickness\": 123, \"link_style\": 123, \"start_arrow\": 123, \"end_arrow\": 123, \"color\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkOverridesPut" }, "task": true }, { "name": "rESTfulLinkOverridesPost", "summary": "Creates a link override.", "description": "Setting override parameter to false creates a list value instead of an\r\n override - a value that doesn't override anything. \r\n Use this link override format for new link overrides creation:\r\n \r\n {\r\n \"value\": \"10\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"thickness\": 1,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New link override.: {\"parent_link_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"rule\": 123, \"is_override\": \"boolean\", \"thickness\": 123, \"link_style\": 123, \"start_arrow\": 123, \"end_arrow\": 123, \"color\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkOverridesPost" }, "task": true }, { "name": "rESTfulLinkOverridesGetById", "summary": "Gets a link override.", "description": "Link override id example: 5", "input": [ { "name": "id", "type": "number", "info": "Link override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkOverridesGetById" }, "task": true }, { "name": "getWapiV1LinkTypePropertiesLinkTypePropertyIdLinkOverrides", "summary": "Gets the link overrides collection for a property.", "description": "Gets the link overrides collection for a property.", "input": [ { "name": "linkTypePropertyId", "type": "number", "info": "Parent link type property id.: 123", "required": true, "schema": { "title": "linkTypePropertyId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1LinkTypePropertiesLinkTypePropertyIdLinkOverrides" }, "task": true }, { "name": "getWapiV1LinkTypePropertiesLinkTypePropertyIdLinkOverridesId", "summary": "Gets a link override.", "description": "Link override id example: 5", "input": [ { "name": "linkTypePropertyId", "type": "number", "info": "Parent link type property id.: 123", "required": true, "schema": { "title": "linkTypePropertyId", "type": "number" } }, { "name": "id", "type": "number", "info": "Link override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1LinkTypePropertiesLinkTypePropertyIdLinkOverridesId" }, "task": true }, { "name": "getWapiV1LinkTypesLinkTypeIdLinkTypePropertiesLinkTypePropertyIdLinkOverrides", "summary": "Gets the link overrides collection for a property.", "description": "Gets the link overrides collection for a property.", "input": [ { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "linkTypePropertyId", "type": "number", "info": "Parent link type property id.: 123", "required": true, "schema": { "title": "linkTypePropertyId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1LinkTypesLinkTypeIdLinkTypePropertiesLinkTypePropertyIdLinkOverrides" }, "task": true }, { "name": "postWapiV1LinkTypesLinkTypeIdLinkTypePropertiesLinkTypePropertyIdLinkOverrides", "summary": "Creates a link override.", "description": "Setting override parameter to false creates a list value instead of an\r\n override - a value that doesn't override anything. \r\n Link that you don't need to specify 'parent_link_type_property' reference\r\n as it is already set by the endpoint Url. \r\n Use this link override format for new link overrides creation:\r\n \r\n {\r\n \"value\": \"10\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"thickness\": 1,\r...(description truncated)", "input": [ { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "linkTypePropertyId", "type": "number", "info": "Parent link type property id.: 123", "required": true, "schema": { "title": "linkTypePropertyId", "type": "number" } }, { "name": "body", "type": "object", "info": "New link override.: {\"parent_link_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"rule\": 123, \"is_override\": \"boolean\", \"thickness\": 123, \"link_style\": 123, \"start_arrow\": 123, \"end_arrow\": 123, \"color\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1LinkTypesLinkTypeIdLinkTypePropertiesLinkTypePropertyIdLinkOverrides" }, "task": true }, { "name": "getWapiV1LinkTypesLinkTypeIdLinkTypePropertiesLinkTypePropertyIdLinkOverridesId", "summary": "Gets a link override.", "description": "Link override id example: 5", "input": [ { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "linkTypePropertyId", "type": "number", "info": "Parent link type property id.: 123", "required": true, "schema": { "title": "linkTypePropertyId", "type": "number" } }, { "name": "id", "type": "number", "info": "Link override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1LinkTypesLinkTypeIdLinkTypePropertiesLinkTypePropertyIdLinkOverridesId" }, "task": true }, { "name": "putWapiV1LinkTypesLinkTypeIdLinkTypePropertiesLinkTypePropertyIdLinkOverridesId", "summary": "Updates an existing link override.", "description": "This update method is triggered by sending PUT request directly to the resource's\r\n 'href' url. For data consistency verification 'href' (if presents) must be the same as the\r\n request url. \r\n 'parent_link_type_property' cannot be changed. \r\n By altering the is_override parameter an override can be transformed into a list\r\n value (\"is_override\": false). \r\n \r\n Use this link categories format for link override update:\r\n \r\n {\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Link override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "linkTypePropertyId", "type": "number", "info": "Parent link type property id.: 123", "required": true, "schema": { "title": "linkTypePropertyId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated link override.: {\"parent_link_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"rule\": 123, \"is_override\": \"boolean\", \"thickness\": 123, \"link_style\": 123, \"start_arrow\": 123, \"end_arrow\": 123, \"color\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1LinkTypesLinkTypeIdLinkTypePropertiesLinkTypePropertyIdLinkOverridesId" }, "task": true }, { "name": "rESTfulLinkOverridesDelete", "summary": "Deletes a link override.", "description": "Deletes a link override.", "input": [ { "name": "id", "type": "number", "info": "Link override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "linkTypeId", "type": "string", "info": ": string", "required": true, "schema": { "title": "linkTypeId", "type": "string" } }, { "name": "linkTypePropertyId", "type": "string", "info": ": string", "required": true, "schema": { "title": "linkTypePropertyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkOverridesDelete" }, "task": true }, { "name": "rESTfulLinkPropertyValuesGet", "summary": "Gets the link property values collection with no relation to a specific link.", "description": "This collection is useful when direct access to link property values is required.\r\n For example, to search a property by its name and value when a parent link is unknown.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkPropertyValuesGet" }, "task": true }, { "name": "rESTfulLinkPropertyValuesPut", "summary": "Updates an existing link property value or multiple values. Creates if does not exist.", "description": "'Type' property value cannot be updated. \r\n Link property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n During creation of a link in the property has a default value.\r\n With the special \"POST .../init_absent_values\" method.\r\n With this PUT method. See the examples. \r\n Use this link property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\":...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated link property value. Or values array.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkPropertyValuesPut" }, "task": true }, { "name": "rESTfulLinkPropertyValuesGetById", "summary": "Gets the link property value.", "description": "Link id format: 25000000000123, Link property value id format: 123456.", "input": [ { "name": "id", "type": "number", "info": "Link property value id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkPropertyValuesGetById" }, "task": true }, { "name": "getWapiV1LinksLinkIdLinkPropertyValues", "summary": "Gets the link property values collection.", "description": "Gets the link property values collection.", "input": [ { "name": "linkId", "type": "number", "info": "Parent link id.: 123", "required": true, "schema": { "title": "linkId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1LinksLinkIdLinkPropertyValues" }, "task": true }, { "name": "putWapiV1LinksLinkIdLinkPropertyValues", "summary": "Updates an existing link property value or created if does not exist.", "description": "'Type' property value cannot be updated. \r\n Link property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n During creation of a link in the property has a default value.\r\n With the special \"POST .../init_absent_values\" method.\r\n With this PUT method. See the examples. \r\n Use this link property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\":...(description truncated)", "input": [ { "name": "linkId", "type": "number", "info": "Parent link id.: 123", "required": true, "schema": { "title": "linkId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated link property value id.: {\"name\": \"string\", \"parent_link\": {\"href\": \"string\"}, \"link_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"displayed_value\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1LinksLinkIdLinkPropertyValues" }, "task": true }, { "name": "getWapiV1LinksLinkIdLinkPropertyValuesId", "summary": "Gets the link property value.", "description": "Link id format: 25000000000123, Link property value id format: 123456.", "input": [ { "name": "linkId", "type": "number", "info": "Parent link id.: 123", "required": true, "schema": { "title": "linkId", "type": "number" } }, { "name": "id", "type": "number", "info": "Link property value id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1LinksLinkIdLinkPropertyValuesId" }, "task": true }, { "name": "putWapiV1LinksLinkIdLinkPropertyValuesId", "summary": "Updates an existing link property value.", "description": "'Type' property value cannot be updated. \r\n Link property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n During creation of a link in the property has a default value.\r\n With the special \"POST .../init_absent_values\" method.\r\n With this PUT method. See the examples. \r\n Use this link property value format:\r\n \r\n {\r\n \"value\": \"New value\"\r\n }", "input": [ { "name": "id", "type": "number", "info": "Link property value id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "linkId", "type": "number", "info": "Parent link id.: 123", "required": true, "schema": { "title": "linkId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated link property value id.: {\"name\": \"string\", \"parent_link\": {\"href\": \"string\"}, \"link_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"displayed_value\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1LinksLinkIdLinkPropertyValuesId" }, "task": true }, { "name": "rESTfulLinkPropertyValuesInitAbsentValues", "summary": "Creates absent link property values.", "description": "All created link property values will be empty and 'Type' property value will\r\n contain a link type name.", "input": [ { "name": "linkId", "type": "number", "info": "User id.: 123", "required": true, "schema": { "title": "linkId", "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": "/rESTfulLinkPropertyValuesInitAbsentValues" }, "task": true }, { "name": "rESTfulLinkTypePropertiesGet", "summary": "Gets the link type properties collection with no relation to a specific link type.", "description": "Gets the link type properties collection with no relation to a specific link type.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypePropertiesGet" }, "task": true }, { "name": "rESTfulLinkTypePropertiesPut", "summary": "Updates an existing link type property or multiple properties.", "description": "When altering the name parameter (renaming the link type property) the new name\r\n must be unique. Only non-system properties can be renamed. \r\n System status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position. \r\n The typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated link type property. Or properties array.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypePropertiesPut" }, "task": true }, { "name": "rESTfulLinkTypePropertiesPost", "summary": "Creates an new link type property.", "description": "Use this link type property format for link type property update:\r\n \r\n {\r\n \"name\": \"Type\",\r\n \"default_value\": \"\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": false,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New link type property.: {\"name\": \"string\", \"parent_link_type\": {\"href\": \"string\"}, \"link_overrides\": {\"href\": \"string\"}, \"is_system\": \"boolean\", \"default_value\": \"string\", \"position\": 123, \"is_mandatory\": \"boolean\", \"is_displayed\": \"boolean\", \"is_in_properties\": \"boolean\", \"text_justification\": 123, \"text_align\": 123, \"font_family\": 123, \"font_size\": 123, \"font_color\": \"string\", \"fill_color\": \"string\", \"offset_x\": 123, \"offset_y\": 123, \"angle\": 123, \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underlined\": \"boolean\", \"is_lock_list\": \"boolean\", \"is_type_field\": \"boolean\", \"is_unique_for_this_type\": \"boolean\", \"is_unique_for_all_types\": \"boolean\", \"is_upright_alignment\": \"boolean\", \"anchor\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_upright_alignment": { "type": "boolean" }, "anchor": { "enum": [ 0, 1, 2 ], "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypePropertiesPost" }, "task": true }, { "name": "rESTfulLinkTypePropertiesGetById", "summary": "Gets a link type property.", "description": "Link type property id example: 28000000000076", "input": [ { "name": "id", "type": "number", "info": "Link type property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_upright_alignment": { "type": "boolean" }, "anchor": { "enum": [ 0, 1, 2 ], "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypePropertiesGetById" }, "task": true }, { "name": "getWapiV1LinkTypesLinkTypeIdLinkTypeProperties", "summary": "Gets the link type properties collection.", "description": "Gets the link type properties collection.", "input": [ { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1LinkTypesLinkTypeIdLinkTypeProperties" }, "task": true }, { "name": "putWapiV1LinkTypesLinkTypeIdLinkTypeProperties", "summary": "Updates an existing link type property.", "description": "When altering the name parameter (renaming the link type property) the new name\r\n must be unique. Only non-system properties can be renamed. \r\n System status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position. \r\n The typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n ...(description truncated)", "input": [ { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated link type property.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1LinkTypesLinkTypeIdLinkTypeProperties" }, "task": true }, { "name": "postWapiV1LinkTypesLinkTypeIdLinkTypeProperties", "summary": "Creates an new link type property.", "description": "Use this link type property format for link type property update:\r\n \r\n {\r\n \"name\": \"Type\",\r\n \"default_value\": \"\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": false,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n ...(description truncated)", "input": [ { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "body", "type": "object", "info": "New link type property.: {\"name\": \"string\", \"parent_link_type\": {\"href\": \"string\"}, \"link_overrides\": {\"href\": \"string\"}, \"is_system\": \"boolean\", \"default_value\": \"string\", \"position\": 123, \"is_mandatory\": \"boolean\", \"is_displayed\": \"boolean\", \"is_in_properties\": \"boolean\", \"text_justification\": 123, \"text_align\": 123, \"font_family\": 123, \"font_size\": 123, \"font_color\": \"string\", \"fill_color\": \"string\", \"offset_x\": 123, \"offset_y\": 123, \"angle\": 123, \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underlined\": \"boolean\", \"is_lock_list\": \"boolean\", \"is_type_field\": \"boolean\", \"is_unique_for_this_type\": \"boolean\", \"is_unique_for_all_types\": \"boolean\", \"is_upright_alignment\": \"boolean\", \"anchor\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_upright_alignment": { "type": "boolean" }, "anchor": { "enum": [ 0, 1, 2 ], "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1LinkTypesLinkTypeIdLinkTypeProperties" }, "task": true }, { "name": "getWapiV1LinkTypesLinkTypeIdLinkTypePropertiesId", "summary": "Gets a link type property.", "description": "Link type property id example: 29000000000076", "input": [ { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Link type property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_upright_alignment": { "type": "boolean" }, "anchor": { "enum": [ 0, 1, 2 ], "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1LinkTypesLinkTypeIdLinkTypePropertiesId" }, "task": true }, { "name": "putWapiV1LinkTypesLinkTypeIdLinkTypePropertiesId", "summary": "Updates an existing link type property.", "description": "When altering the name parameter (renaming the link type property) the new name\r\n must be unique. Only non-system properties can be renamed. \r\n System status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position. \r\n The typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Link type property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "linkTypeId", "type": "number", "info": "Parent link type id.: 123", "required": true, "schema": { "title": "linkTypeId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated link type property.: {\"name\": \"string\", \"parent_link_type\": {\"href\": \"string\"}, \"link_overrides\": {\"href\": \"string\"}, \"is_system\": \"boolean\", \"default_value\": \"string\", \"position\": 123, \"is_mandatory\": \"boolean\", \"is_displayed\": \"boolean\", \"is_in_properties\": \"boolean\", \"text_justification\": 123, \"text_align\": 123, \"font_family\": 123, \"font_size\": 123, \"font_color\": \"string\", \"fill_color\": \"string\", \"offset_x\": 123, \"offset_y\": 123, \"angle\": 123, \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underlined\": \"boolean\", \"is_lock_list\": \"boolean\", \"is_type_field\": \"boolean\", \"is_unique_for_this_type\": \"boolean\", \"is_unique_for_all_types\": \"boolean\", \"is_upright_alignment\": \"boolean\", \"anchor\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_link_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_upright_alignment": { "type": "boolean" }, "anchor": { "enum": [ 0, 1, 2 ], "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1LinkTypesLinkTypeIdLinkTypePropertiesId" }, "task": true }, { "name": "rESTfulLinkTypePropertiesDelete", "summary": "Deletes a link type property.", "description": "Only non-system link type properties can be deleted.", "input": [ { "name": "id", "type": "number", "info": "Link type property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "linkTypeId", "type": "string", "info": ": string", "required": true, "schema": { "title": "linkTypeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypePropertiesDelete" }, "task": true }, { "name": "rESTfulLinkTypesGet", "summary": "Gets the link types collection.", "description": "Gets the link types collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypesGet" }, "task": true }, { "name": "rESTfulLinkTypesPut", "summary": "Updates an existing link type.", "description": "System link types cannot be updated. The system parameter cannot be altered\r\n either. \r\n \r\n When altering the name parameter (renaming the link type) the new name\r\n must be unique. \r\n \r\n A favorite link type or a link type with existing link instances cannot be\r\n disabled. \r\n Use this link type format for link override update:\r\n \r\n {\r\n \"name\": \"Copper\",\r\n \"is_favorite\": true,\r\n \"is_system\": fal...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated link type.: {\"name\": \"string\", \"is_favorite\": \"boolean\", \"is_system\": \"boolean\", \"is_enabled\": \"boolean\", \"is_snapped_to_edge\": \"boolean\", \"is_matching_port_connectors\": \"boolean\", \"thickness\": 123, \"link_style\": 123, \"start_arrow\": 123, \"end_arrow\": 123, \"color\": \"string\", \"link_category\": {\"href\": \"string\"}, \"link_type_properties\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_favorite": { "type": "boolean" }, "is_system": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "is_snapped_to_edge": { "type": "boolean" }, "is_matching_port_connectors": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "link_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_type_properties": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypesPut" }, "task": true }, { "name": "rESTfulLinkTypesPost", "summary": "Creates an new link type.", "description": "Use this link types format for link type create:\r\n \r\n {\r\n \"name\": \"Copper\",\r\n \"is_favorite\": true,\r\n \"is_system\": false,\r\n \"is_enabled\": true,\r\n \"is_snapped_to_edge\": false,\r\n \"is_matching_port_connectors\": false,\r\n \"thickness\": 2,\r\n \"link_style\": \"Solid\",\r\n \"start_arrow\": \"Plain\",\r\n \"end_arrow\": \"Plain\",\r\n \"color\": \"#800000\",\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New link type.: {\"name\": \"string\", \"is_favorite\": \"boolean\", \"is_system\": \"boolean\", \"is_enabled\": \"boolean\", \"is_snapped_to_edge\": \"boolean\", \"is_matching_port_connectors\": \"boolean\", \"thickness\": 123, \"link_style\": 123, \"start_arrow\": 123, \"end_arrow\": 123, \"color\": \"string\", \"link_category\": {\"href\": \"string\"}, \"link_type_properties\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_favorite": { "type": "boolean" }, "is_system": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "is_snapped_to_edge": { "type": "boolean" }, "is_matching_port_connectors": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "link_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_type_properties": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypesPost" }, "task": true }, { "name": "rESTfulLinkTypesGetById", "summary": "Gets a link type.", "description": "Link type id example: 27000000000017", "input": [ { "name": "id", "type": "number", "info": "Link type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_favorite": { "type": "boolean" }, "is_system": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "is_snapped_to_edge": { "type": "boolean" }, "is_matching_port_connectors": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "link_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_type_properties": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulLinkTypesGetById" }, "task": true }, { "name": "putWapiV1LinkTypesId", "summary": "Updates an existing link type.", "description": "System link types cannot be updated. The system parameter cannot be altered\r\n either. \r\n \r\n When altering the name parameter (renaming the link type) the new name\r\n must be unique. \r\n \r\n A favorite link type or a link type with existing link instances cannot be\r\n disabled. \r\n Use this link type format for link override update:\r\n \r\n {\r\n \"name\": \"Copper\",\r\n \"is_favorite\": true,\r\n \"is_system\": fal...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Link type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated link type.: {\"name\": \"string\", \"is_favorite\": \"boolean\", \"is_system\": \"boolean\", \"is_enabled\": \"boolean\", \"is_snapped_to_edge\": \"boolean\", \"is_matching_port_connectors\": \"boolean\", \"thickness\": 123, \"link_style\": 123, \"start_arrow\": 123, \"end_arrow\": 123, \"color\": \"string\", \"link_category\": {\"href\": \"string\"}, \"link_type_properties\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "is_favorite": { "type": "boolean" }, "is_system": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "is_snapped_to_edge": { "type": "boolean" }, "is_matching_port_connectors": { "type": "boolean" }, "thickness": { "type": "number" }, "link_style": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "start_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "end_arrow": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, -2, -1 ], "type": "integer" }, "color": { "type": "string" }, "link_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "link_type_properties": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1LinkTypesId" }, "task": true }, { "name": "rESTfulLinkTypesDelete", "summary": "Deletes a link type.", "description": "Only non-system link types without associated links can be deleted.", "input": [ { "name": "id", "type": "number", "info": "Link type id.: 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": "/rESTfulLinkTypesDelete" }, "task": true }, { "name": "rESTfulVisLinksGet", "summary": "Gets the vis links collection.", "description": "Gets the vis links collection.", "input": [ { "name": "linkId", "type": "number", "info": "Parent link id.: 123", "required": true, "schema": { "title": "linkId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisLinksGet" }, "task": true }, { "name": "rESTfulVisLinksPut", "summary": "Updates an existing vis link.", "description": "Use this format for vis link update:\r\n \r\n {\r\n \"is_curved\": false,\r\n \"bend_points_path\": \"\",\r\n \"from_anchor_point_x\": 0.5,\r\n \"from_anchor_point_y\": 0.5,\r\n \"to_anchor_point_x\": 0.5,\r\n \"to_anchor_point_y\": 0.5,\r\n \"can_move\": true,\r\n \"can_delete\": true,\r\n \"is_hidden\": false,\r\n \"is_snapped_to_edge\": false,\r\n \"z_order\": 0,\r\n ...(description truncated)", "input": [ { "name": "visLink", "type": "object", "info": "Updated vis link.: {\"parent_diagram\": {\"href\": \"string\"}, \"displayed_fields\": {\"href\": \"string\"}, \"is_curved\": \"boolean\", \"bend_points_path\": \"string\", \"from_anchor_point_x\": 123, \"from_anchor_point_y\": 123, \"to_anchor_point_x\": 123, \"to_anchor_point_y\": 123, \"can_move\": \"boolean\", \"can_delete\": \"boolean\", \"is_hidden\": \"boolean\", \"is_snapped_to_edge\": \"boolean\", \"z_order\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "displayed_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_curved": { "type": "boolean" }, "bend_points_path": { "type": "string" }, "from_anchor_point_x": { "type": "number" }, "from_anchor_point_y": { "type": "number" }, "to_anchor_point_x": { "type": "number" }, "to_anchor_point_y": { "type": "number" }, "can_move": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "is_hidden": { "type": "boolean" }, "is_snapped_to_edge": { "type": "boolean" }, "z_order": { "type": "integer" }, "href": { "type": "string" } } } }, { "name": "linkId", "type": "string", "info": ": string", "required": true, "schema": { "title": "linkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisLinksPut" }, "task": true }, { "name": "rESTfulVisLinksGetById", "summary": "Gets the vis link.", "description": "Link id example: 25000000000123, Vis Link id example: 123", "input": [ { "name": "linkId", "type": "number", "info": "Parent link id.: 123", "required": true, "schema": { "title": "linkId", "type": "number" } }, { "name": "id", "type": "number", "info": "Vis Link id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "displayed_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_curved": { "type": "boolean" }, "bend_points_path": { "type": "string" }, "from_anchor_point_x": { "type": "number" }, "from_anchor_point_y": { "type": "number" }, "to_anchor_point_x": { "type": "number" }, "to_anchor_point_y": { "type": "number" }, "can_move": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "is_hidden": { "type": "boolean" }, "is_snapped_to_edge": { "type": "boolean" }, "z_order": { "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisLinksGetById" }, "task": true }, { "name": "rESTfulNodeCategoriesGet", "summary": "Gets the node categories collection.", "description": "Gets the node categories collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeCategoriesGet" }, "task": true }, { "name": "rESTfulNodeCategoriesPut", "summary": "Updates an existing node category.", "description": "When altering the name parameter (renaming the node category) the new name must\r\n be unique throughout all node categories. \r\n \r\n When changing the image, parameter the image file should already exist\r\n on the server. The same icon image can be used for different categories. Use an empty string\r\n to remove the icon image. \r\n The type group of the node category cannot be changed. \r\n To set or alter the parent parameter (reparenting) the node type\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated node category.: {\"parent_node_category\": {\"href\": \"string\"}, \"name\": \"string\", \"image\": \"string\", \"node_type_group\": 123, \"is_favorite\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_node_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "image": { "type": "string" }, "node_type_group": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "is_favorite": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeCategoriesPut" }, "task": true }, { "name": "rESTfulNodeCategoriesPost", "summary": "Creates a node category.", "description": "Use this node category format for new node categories creation:\r\n \r\n {\r\n \"name\": \"New category\",\r\n \"node_type_group\": \"Node\",\r\n \"is_favorite\": true,\r\n \"parent_node_category\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_categories/31000000000003\"\r\n }\r\n }", "input": [ { "name": "body", "type": "object", "info": "New node category.: {\"parent_node_category\": {\"href\": \"string\"}, \"name\": \"string\", \"image\": \"string\", \"node_type_group\": 123, \"is_favorite\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_node_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "image": { "type": "string" }, "node_type_group": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "is_favorite": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeCategoriesPost" }, "task": true }, { "name": "rESTfulNodeCategoriesGetById", "summary": "Gets a node category.", "description": "Node category id example: 31000000000004", "input": [ { "name": "id", "type": "number", "info": "Node category id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_node_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "image": { "type": "string" }, "node_type_group": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "is_favorite": { "type": "boolean" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeCategoriesGetById" }, "task": true }, { "name": "putWapiV1NodeCategoriesId", "summary": "Updates an existing node category.", "description": "When altering the name parameter (renaming the node category) the new name must\r\n be unique throughout all node categories. \r\n \r\n When changing the image, parameter the image file should already exist\r\n on the server. The same icon image can be used for different categories. Use an empty string\r\n to remove the icon image. \r\n The type group of the node category cannot be changed. \r\n To set or alter the parent parameter (reparenting) the node type\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Node category id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node category.: {\"parent_node_category\": {\"href\": \"string\"}, \"name\": \"string\", \"image\": \"string\", \"node_type_group\": 123, \"is_favorite\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_node_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "image": { "type": "string" }, "node_type_group": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "is_favorite": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1NodeCategoriesId" }, "task": true }, { "name": "rESTfulNodeCategoriesDelete", "summary": "Deletes a node category.", "description": "Node categories in use cannot be deleted.", "input": [ { "name": "id", "type": "number", "info": "Node category id.: 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": "/rESTfulNodeCategoriesDelete" }, "task": true }, { "name": "rESTfulNodeOverridesGet", "summary": "Gets the general node overrides collection.", "description": "Gets the general node overrides collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeOverridesGet" }, "task": true }, { "name": "rESTfulNodeOverridesPut", "summary": "Updates an existing node override.", "description": "As the general node overrides endpoint is used the updated resource is identified by\r\n its 'href' in the body. \r\n 'parent_node_type_property' cannot be changed. \r\n By altering the is_override parameter an override can be transformed into a list\r\n value (\"is_override\": false). \r\n Use this node categories format for node override update:\r\n \r\n {\r\n \"parent_node_type_property\": {\r\n \"href\": \"https://[netTerrain App Url]/wapi...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated node override.: {\"parent_node_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"rule\": 123, \"is_override\": \"boolean\", \"image\": \"string\", \"instance_effect\": 123, \"parent_effect\": 123, \"upwards_propagation\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "image": { "type": "string" }, "instance_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "parent_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "upwards_propagation": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeOverridesPut" }, "task": true }, { "name": "rESTfulNodeOverridesPost", "summary": "Creates a node override.", "description": "Setting override parameter to false creates a list value instead of an\r\n override - a value that doesn't override anything. \r\n Use this node override format for new node overrides creation:\r\n \r\n {\r\n \"parent_node_type_property\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123/node_type_properties/28000000000123\"\r\n },\r\n \"value\": \"45\",\r\n \"rule\": \"Equals\",\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New node override.: {\"parent_node_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"rule\": 123, \"is_override\": \"boolean\", \"image\": \"string\", \"instance_effect\": 123, \"parent_effect\": 123, \"upwards_propagation\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "image": { "type": "string" }, "instance_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "parent_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "upwards_propagation": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeOverridesPost" }, "task": true }, { "name": "rESTfulNodeOverridesGetById", "summary": "Gets a node override.", "description": "Node override id example: 5", "input": [ { "name": "id", "type": "number", "info": "Node override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "image": { "type": "string" }, "instance_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "parent_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "upwards_propagation": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeOverridesGetById" }, "task": true }, { "name": "getWapiV1NodeTypePropertiesNodeTypePropertyIdNodeOverrides", "summary": "Gets the node overrides collection for a property.", "description": "Gets the node overrides collection for a property.", "input": [ { "name": "nodeTypePropertyId", "type": "number", "info": "Parent node type property id.: 123", "required": true, "schema": { "title": "nodeTypePropertyId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1NodeTypePropertiesNodeTypePropertyIdNodeOverrides" }, "task": true }, { "name": "getWapiV1NodeTypePropertiesNodeTypePropertyIdNodeOverridesId", "summary": "Gets a node override.", "description": "Node override id example: 5", "input": [ { "name": "nodeTypePropertyId", "type": "number", "info": "Parent node type property id.: 123", "required": true, "schema": { "title": "nodeTypePropertyId", "type": "number" } }, { "name": "id", "type": "number", "info": "Node override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "image": { "type": "string" }, "instance_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "parent_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "upwards_propagation": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1NodeTypePropertiesNodeTypePropertyIdNodeOverridesId" }, "task": true }, { "name": "getWapiV1NodeTypesNodeTypeIdNodeTypePropertiesNodeTypePropertyIdNodeOverrides", "summary": "Gets the node overrides collection for a property.", "description": "Gets the node overrides collection for a property.", "input": [ { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "nodeTypePropertyId", "type": "number", "info": "Parent node type property id.: 123", "required": true, "schema": { "title": "nodeTypePropertyId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1NodeTypesNodeTypeIdNodeTypePropertiesNodeTypePropertyIdNodeOverrides" }, "task": true }, { "name": "postWapiV1NodeTypesNodeTypeIdNodeTypePropertiesNodeTypePropertyIdNodeOverrides", "summary": "Creates a node override.", "description": "Setting override parameter to false creates a list value instead of an\r\n override - a value that doesn't override anything. \r\n Node that you don't need to specify 'parent_node_type_property' reference\r\n as it is already set by the endpoint Url. \r\n Use this node override format for new node overrides creation:\r\n \r\n {\r\n \"value\": \"45\",\r\n \"rule\": \"Equals\",\r\n \"is_override\": true,\r\n \"image\": \"5ybawb...(description truncated)", "input": [ { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "nodeTypePropertyId", "type": "number", "info": "Parent node type property id.: 123", "required": true, "schema": { "title": "nodeTypePropertyId", "type": "number" } }, { "name": "body", "type": "object", "info": "New node override.: {\"parent_node_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"rule\": 123, \"is_override\": \"boolean\", \"image\": \"string\", \"instance_effect\": 123, \"parent_effect\": 123, \"upwards_propagation\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "image": { "type": "string" }, "instance_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "parent_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "upwards_propagation": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1NodeTypesNodeTypeIdNodeTypePropertiesNodeTypePropertyIdNodeOverrides" }, "task": true }, { "name": "getWapiV1NodeTypesNodeTypeIdNodeTypePropertiesNodeTypePropertyIdNodeOverridesId", "summary": "Gets a node override.", "description": "Node override id example: 5", "input": [ { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "nodeTypePropertyId", "type": "number", "info": "Parent node type property id.: 123", "required": true, "schema": { "title": "nodeTypePropertyId", "type": "number" } }, { "name": "id", "type": "number", "info": "Node override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "image": { "type": "string" }, "instance_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "parent_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "upwards_propagation": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1NodeTypesNodeTypeIdNodeTypePropertiesNodeTypePropertyIdNodeOverridesId" }, "task": true }, { "name": "putWapiV1NodeTypesNodeTypeIdNodeTypePropertiesNodeTypePropertyIdNodeOverridesId", "summary": "Updates an existing node override.", "description": "This update method is triggered by sending PUT request directly to the resource's\r\n 'href' url. For data consistency verification 'href' (if presents) must be the same as the\r\n request url. \r\n 'parent_node_type_property' cannot be changed. \r\n By altering the is_override parameter an override can be transformed into a list\r\n value (\"is_override\": false). \r\n \r\n Use this node categories format for node override update:\r\n \r\n {\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Node override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "nodeTypePropertyId", "type": "number", "info": "Parent node type property id.: 123", "required": true, "schema": { "title": "nodeTypePropertyId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node override.: {\"parent_node_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"rule\": 123, \"is_override\": \"boolean\", \"image\": \"string\", \"instance_effect\": 123, \"parent_effect\": 123, \"upwards_propagation\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "rule": { "enum": [ 0, 1, 4, 5, -1 ], "type": "integer" }, "is_override": { "type": "boolean" }, "image": { "type": "string" }, "instance_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "parent_effect": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "upwards_propagation": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1NodeTypesNodeTypeIdNodeTypePropertiesNodeTypePropertyIdNodeOverridesId" }, "task": true }, { "name": "rESTfulNodeOverridesDelete", "summary": "Deletes a node override.", "description": "Deletes a node override.", "input": [ { "name": "id", "type": "number", "info": "Node override id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "nodeTypeId", "type": "string", "info": ": string", "required": true, "schema": { "title": "nodeTypeId", "type": "string" } }, { "name": "nodeTypePropertyId", "type": "string", "info": ": string", "required": true, "schema": { "title": "nodeTypePropertyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeOverridesDelete" }, "task": true }, { "name": "rESTfulNodePropertyValuesGet", "summary": "Gets the node property values collection with no relation to a specific node.", "description": "This collection is useful when direct access to node property values is required.\r\n For example, to search a property by its name and value when a parent node is unknown.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodePropertyValuesGet" }, "task": true }, { "name": "rESTfulNodePropertyValuesPut", "summary": "Updates an existing node property value or multiple values. Creates if does not exist.", "description": "'Type' property value cannot be updated. \r\n Node property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n During creation of a node in the property has a default value.\r\n With the special \"POST .../init_absent_values\" method.\r\n With this PUT method. See the examples. \r\n Use this node property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\":...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated node property value. Or values array.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodePropertyValuesPut" }, "task": true }, { "name": "rESTfulNodePropertyValuesGetById", "summary": "Gets the node property value.", "description": "Node id example: 24000000000123, Node property value id example: 123.", "input": [ { "name": "id", "type": "number", "info": "Node property value id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodePropertyValuesGetById" }, "task": true }, { "name": "getWapiV1NodesNodeIdNodePropertyValues", "summary": "Gets the node property values collection.", "description": "Gets the node property values collection.", "input": [ { "name": "nodeId", "type": "number", "info": "Parent node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1NodesNodeIdNodePropertyValues" }, "task": true }, { "name": "putWapiV1NodesNodeIdNodePropertyValues", "summary": "Updates an existing node property value or created if does not exist.", "description": "'Type' property value cannot be updated. \r\n Node property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n During creation of a node in the property has a default value.\r\n With the special \"POST .../init_absent_values\" method.\r\n With this PUT method. See the examples. \r\n Use this node property value format:\r\n \r\n {\r\n \"value\": \"New value\",\r\n \"href\":...(description truncated)", "input": [ { "name": "nodeId", "type": "number", "info": "Parent node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node property value id.: {\"name\": \"string\", \"parent_node\": {\"href\": \"string\"}, \"node_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"displayed_value\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1NodesNodeIdNodePropertyValues" }, "task": true }, { "name": "getWapiV1NodesNodeIdNodePropertyValuesId", "summary": "Gets the node property value.", "description": "Node id example: 24000000000123, Node property value id example: 123.", "input": [ { "name": "nodeId", "type": "number", "info": "Parent node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Node property value id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1NodesNodeIdNodePropertyValuesId" }, "task": true }, { "name": "putWapiV1NodesNodeIdNodePropertyValuesId", "summary": "Updates an existing node property value.", "description": "'Type' property value cannot be updated. \r\n Node property value does not exist by default. It will be created in netTerrain in\r\n one of following cases:\r\n During creation of a node in the property has a default value.\r\n With the special \"POST .../init_absent_values\" method.\r\n With this PUT method. See the examples. \r\n Use this node property value format:\r\n \r\n {\r\n \"value\": \"New value\"\r\n }", "input": [ { "name": "id", "type": "number", "info": "Node property value id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "nodeId", "type": "number", "info": "Parent node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node property value id.: {\"name\": \"string\", \"parent_node\": {\"href\": \"string\"}, \"node_type_property\": {\"href\": \"string\"}, \"value\": \"string\", \"displayed_value\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_property": { "type": "object", "properties": { "href": { "type": "string" } } }, "value": { "type": "string" }, "displayed_value": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1NodesNodeIdNodePropertyValuesId" }, "task": true }, { "name": "rESTfulNodePropertyValuesInitAbsentValues", "summary": "Creates absent node property values.", "description": "All created node property values will be empty and 'Type' property value will\r\n contain a node type name.", "input": [ { "name": "nodeId", "type": "number", "info": "User id.: 123", "required": true, "schema": { "title": "nodeId", "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": "/rESTfulNodePropertyValuesInitAbsentValues" }, "task": true }, { "name": "rESTfulNodeTypePropertiesGet", "summary": "Gets the node type properties collection with no relation to a specific node type.", "description": "Gets the node type properties collection with no relation to a specific node type.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypePropertiesGet" }, "task": true }, { "name": "rESTfulNodeTypePropertiesPut", "summary": "Updates an existing node type property or multiple properties.", "description": "When altering the name parameter (renaming the node type property) the new name\r\n must be unique. Only non-system properties can be renamed. \r\n System status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position. \r\n The typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated node type property. Or properties array.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypePropertiesPut" }, "task": true }, { "name": "rESTfulNodeTypePropertiesPost", "summary": "Creates an new node type property.", "description": "Use this node type property format for node type property update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"default_value\": \"Stamp\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": true,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New node type property.: {\"name\": \"string\", \"parent_node_type\": {\"href\": \"string\"}, \"node_overrides\": {\"href\": \"string\"}, \"is_system\": \"boolean\", \"default_value\": \"string\", \"position\": 123, \"is_mandatory\": \"boolean\", \"is_displayed\": \"boolean\", \"is_in_properties\": \"boolean\", \"text_justification\": 123, \"text_align\": 123, \"font_family\": 123, \"font_size\": 123, \"font_color\": \"string\", \"fill_color\": \"string\", \"offset_x\": 123, \"offset_y\": 123, \"angle\": 123, \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underlined\": \"boolean\", \"is_lock_list\": \"boolean\", \"is_type_field\": \"boolean\", \"is_unique_for_this_type\": \"boolean\", \"is_unique_for_all_types\": \"boolean\", \"is_not_editable\": \"boolean\", \"system_object_id\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_not_editable": { "type": "boolean" }, "system_object_id": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypePropertiesPost" }, "task": true }, { "name": "rESTfulNodeTypePropertiesGetById", "summary": "Gets a node type property.", "description": "Node type property id example: 28000000000076", "input": [ { "name": "id", "type": "number", "info": "Node type property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_not_editable": { "type": "boolean" }, "system_object_id": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypePropertiesGetById" }, "task": true }, { "name": "getWapiV1NodeTypesNodeTypeIdNodeTypeProperties", "summary": "Gets the node type properties collection.", "description": "Gets the node type properties collection.", "input": [ { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1NodeTypesNodeTypeIdNodeTypeProperties" }, "task": true }, { "name": "putWapiV1NodeTypesNodeTypeIdNodeTypeProperties", "summary": "Updates an existing node type property.", "description": "When altering the name parameter (renaming the node type property) the new name\r\n must be unique. Only non-system properties can be renamed. \r\n System status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position. \r\n The typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n ...(description truncated)", "input": [ { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node type property.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1NodeTypesNodeTypeIdNodeTypeProperties" }, "task": true }, { "name": "postWapiV1NodeTypesNodeTypeIdNodeTypeProperties", "summary": "Creates an new node type property.", "description": "Use this node type property format for node type property update:\r\n \r\n {\r\n \"name\": \"Name\",\r\n \"default_value\": \"Stamp\",\r\n \"is_mandatory\": true,\r\n \"is_displayed\": true,\r\n \"is_in_properties\": true,\r\n \"text_justification\": \"TopLeft\",\r\n \"text_align\": \"Left\",\r\n \"font_family\": \"Arial\",\r\n \"font_size\": 10,\r\n \"font_color\": \"#000000\",\r\n ...(description truncated)", "input": [ { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "body", "type": "object", "info": "New node type property.: {\"name\": \"string\", \"parent_node_type\": {\"href\": \"string\"}, \"node_overrides\": {\"href\": \"string\"}, \"is_system\": \"boolean\", \"default_value\": \"string\", \"position\": 123, \"is_mandatory\": \"boolean\", \"is_displayed\": \"boolean\", \"is_in_properties\": \"boolean\", \"text_justification\": 123, \"text_align\": 123, \"font_family\": 123, \"font_size\": 123, \"font_color\": \"string\", \"fill_color\": \"string\", \"offset_x\": 123, \"offset_y\": 123, \"angle\": 123, \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underlined\": \"boolean\", \"is_lock_list\": \"boolean\", \"is_type_field\": \"boolean\", \"is_unique_for_this_type\": \"boolean\", \"is_unique_for_all_types\": \"boolean\", \"is_not_editable\": \"boolean\", \"system_object_id\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_not_editable": { "type": "boolean" }, "system_object_id": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1NodeTypesNodeTypeIdNodeTypeProperties" }, "task": true }, { "name": "getWapiV1NodeTypesNodeTypeIdNodeTypePropertiesId", "summary": "Gets a node type property.", "description": "Node type property id example: 28000000000076", "input": [ { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Node type property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_not_editable": { "type": "boolean" }, "system_object_id": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1NodeTypesNodeTypeIdNodeTypePropertiesId" }, "task": true }, { "name": "putWapiV1NodeTypesNodeTypeIdNodeTypePropertiesId", "summary": "Updates an existing node type property.", "description": "When altering the name parameter (renaming the node type property) the new name\r\n must be unique. Only non-system properties can be renamed. \r\n System status of a property cannot be changed. The following parameters of system\r\n properties cannot be changed: name, inproperties, mandatory,\r\n locklist, position. \r\n The typefield parameter cannot be changed. For type fields following\r\n parameters cannot be changed: defaultvalue, noteditable,\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Node type property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "nodeTypeId", "type": "number", "info": "Parent node type id.: 123", "required": true, "schema": { "title": "nodeTypeId", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node type property.: {\"name\": \"string\", \"parent_node_type\": {\"href\": \"string\"}, \"node_overrides\": {\"href\": \"string\"}, \"is_system\": \"boolean\", \"default_value\": \"string\", \"position\": 123, \"is_mandatory\": \"boolean\", \"is_displayed\": \"boolean\", \"is_in_properties\": \"boolean\", \"text_justification\": 123, \"text_align\": 123, \"font_family\": 123, \"font_size\": 123, \"font_color\": \"string\", \"fill_color\": \"string\", \"offset_x\": 123, \"offset_y\": 123, \"angle\": 123, \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underlined\": \"boolean\", \"is_lock_list\": \"boolean\", \"is_type_field\": \"boolean\", \"is_unique_for_this_type\": \"boolean\", \"is_unique_for_all_types\": \"boolean\", \"is_not_editable\": \"boolean\", \"system_object_id\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_overrides": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_system": { "type": "boolean" }, "default_value": { "type": "string" }, "position": { "type": "integer" }, "is_mandatory": { "type": "boolean" }, "is_displayed": { "type": "boolean" }, "is_in_properties": { "type": "boolean" }, "text_justification": { "enum": [ 0, 1 ], "type": "integer" }, "text_align": { "enum": [ 0, 1, 2 ], "type": "integer" }, "font_family": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "font_size": { "type": "number" }, "font_color": { "type": "string" }, "fill_color": { "type": "string" }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "angle": { "type": "integer" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underlined": { "type": "boolean" }, "is_lock_list": { "type": "boolean" }, "is_type_field": { "type": "boolean" }, "is_unique_for_this_type": { "type": "boolean" }, "is_unique_for_all_types": { "type": "boolean" }, "is_not_editable": { "type": "boolean" }, "system_object_id": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1NodeTypesNodeTypeIdNodeTypePropertiesId" }, "task": true }, { "name": "rESTfulNodeTypePropertiesDelete", "summary": "Deletes a node type property.", "description": "Only non-system node type properties can be deleted.", "input": [ { "name": "id", "type": "number", "info": "Node type property id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "nodeTypeId", "type": "string", "info": ": string", "required": true, "schema": { "title": "nodeTypeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypePropertiesDelete" }, "task": true }, { "name": "rESTfulNodeTypesGet", "summary": "Gets the node types collection.", "description": "Gets the node types collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypesGet" }, "task": true }, { "name": "rESTfulNodeTypesPut", "summary": "Updates an existing node type.", "description": "System node types cannot be updated. The system parameter cannot be altered\r\n either. \r\n The type group of the node type cannot be changed. \r\n When altering the name parameter (renaming the node type) the new name must be\r\n unique. \r\n When changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated node type.: {\"name\": \"string\", \"image\": \"string\", \"default_height\": 123, \"default_width\": 123, \"node_type_group\": 123, \"is_favorite\": \"boolean\", \"is_system\": \"boolean\", \"is_enabled\": \"boolean\", \"description\": \"string\", \"is_keep_aspect_ratio\": \"boolean\", \"double_click_behavior\": 123, \"double_click_behavior_attribute\": \"string\", \"template\": {\"href\": \"string\"}, \"hierarchy_browser_label\": {\"href\": \"string\"}, \"node_category\": {\"href\": \"string\"}, \"node_type_properties\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "default_height": { "type": "number" }, "default_width": { "type": "number" }, "node_type_group": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "is_favorite": { "type": "boolean" }, "is_system": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "description": { "type": "string" }, "is_keep_aspect_ratio": { "type": "boolean" }, "double_click_behavior": { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "double_click_behavior_attribute": { "type": "string" }, "template": { "type": "object", "properties": { "href": { "type": "string" } } }, "hierarchy_browser_label": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_properties": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypesPut" }, "task": true }, { "name": "rESTfulNodeTypesPost", "summary": "Creates an new node type.", "description": "It is only possible to add node types of following type groups:\r\n Node, Device, Rack, Card.\r\n \r\n Use this node types format for node type create:\r\n \r\n {\r\n \"name\": \"Region\",\r\n \"image\": \"Region.png\",\r\n \"background\": \"\",\r\n \"default_height\": 50,\r\n \"default_width\": 50,\r\n \"node_type_group\": \"Node\",\r\n \"is_favorite\": true,\r\n \"is_system\": false,\r...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New node type.: {\"name\": \"string\", \"image\": \"string\", \"default_height\": 123, \"default_width\": 123, \"node_type_group\": 123, \"is_favorite\": \"boolean\", \"is_system\": \"boolean\", \"is_enabled\": \"boolean\", \"description\": \"string\", \"is_keep_aspect_ratio\": \"boolean\", \"double_click_behavior\": 123, \"double_click_behavior_attribute\": \"string\", \"template\": {\"href\": \"string\"}, \"hierarchy_browser_label\": {\"href\": \"string\"}, \"node_category\": {\"href\": \"string\"}, \"node_type_properties\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "default_height": { "type": "number" }, "default_width": { "type": "number" }, "node_type_group": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "is_favorite": { "type": "boolean" }, "is_system": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "description": { "type": "string" }, "is_keep_aspect_ratio": { "type": "boolean" }, "double_click_behavior": { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "double_click_behavior_attribute": { "type": "string" }, "template": { "type": "object", "properties": { "href": { "type": "string" } } }, "hierarchy_browser_label": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_properties": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypesPost" }, "task": true }, { "name": "rESTfulNodeTypesGetById", "summary": "Gets a node type.", "description": "Node type id example: 26000000000123", "input": [ { "name": "id", "type": "number", "info": "Node type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "default_height": { "type": "number" }, "default_width": { "type": "number" }, "node_type_group": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "is_favorite": { "type": "boolean" }, "is_system": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "description": { "type": "string" }, "is_keep_aspect_ratio": { "type": "boolean" }, "double_click_behavior": { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "double_click_behavior_attribute": { "type": "string" }, "template": { "type": "object", "properties": { "href": { "type": "string" } } }, "hierarchy_browser_label": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_properties": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeTypesGetById" }, "task": true }, { "name": "putWapiV1NodeTypesId", "summary": "Updates an existing node type.", "description": "System node types cannot be updated. The system parameter cannot be altered\r\n either. \r\n The type group of the node type cannot be changed. \r\n When altering the name parameter (renaming the node type) the new name must be\r\n unique. \r\n When changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Node type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node type.: {\"name\": \"string\", \"image\": \"string\", \"default_height\": 123, \"default_width\": 123, \"node_type_group\": 123, \"is_favorite\": \"boolean\", \"is_system\": \"boolean\", \"is_enabled\": \"boolean\", \"description\": \"string\", \"is_keep_aspect_ratio\": \"boolean\", \"double_click_behavior\": 123, \"double_click_behavior_attribute\": \"string\", \"template\": {\"href\": \"string\"}, \"hierarchy_browser_label\": {\"href\": \"string\"}, \"node_category\": {\"href\": \"string\"}, \"node_type_properties\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "default_height": { "type": "number" }, "default_width": { "type": "number" }, "node_type_group": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer" }, "is_favorite": { "type": "boolean" }, "is_system": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "description": { "type": "string" }, "is_keep_aspect_ratio": { "type": "boolean" }, "double_click_behavior": { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "double_click_behavior_attribute": { "type": "string" }, "template": { "type": "object", "properties": { "href": { "type": "string" } } }, "hierarchy_browser_label": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_category": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type_properties": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1NodeTypesId" }, "task": true }, { "name": "rESTfulNodeTypesDelete", "summary": "Deletes a node type.", "description": "Only non-system node types without associated nodes can be deleted.", "input": [ { "name": "id", "type": "number", "info": "Node type id.: 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": "/rESTfulNodeTypesDelete" }, "task": true }, { "name": "rESTfulNodesGet", "summary": "Gets the nodes collection.", "description": "Gets the nodes collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodesGet" }, "task": true }, { "name": "rESTfulNodesPut", "summary": "Updates an existing node.", "description": "Use this node format:\r\n \r\n {\r\n \"name\": \"New Node\",\r\n \"node_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123\"\r\n },\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n }", "input": [ { "name": "body", "type": "object", "info": "Updated node.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodesPut" }, "task": true }, { "name": "rESTfulNodesPost", "summary": "Creates a node.", "description": "Use this node format for new node creation:\r\n \r\n {\r\n \"name\": \"New Node\",\r\n \"node_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123\"\r\n },\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n }\r\n }", "input": [ { "name": "body", "type": "object", "info": "New node.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodesPost" }, "task": true }, { "name": "rESTfulNodesGetById", "summary": "Gets the node.", "description": "Node id example: 24000000000123", "input": [ { "name": "id", "type": "number", "info": "Node id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "creator": { "type": "object", "properties": { "href": { "type": "string" } } }, "master_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "diagram_settings": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_property_values": { "type": "object", "properties": { "href": { "type": "string" } } }, "vis_nodes": { "type": "object", "properties": { "href": { "type": "string" } } }, "map_coordinates": { "type": "object", "properties": { "href": { "type": "string" } } }, "aliases": { "type": "object", "properties": { "href": { "type": "string" } } }, "double_click_behavior": { "type": "string" }, "is_alias": { "type": "boolean" }, "breadcrumbs": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodesGetById" }, "task": true }, { "name": "putWapiV1NodesId", "summary": "Updates an existing node.", "description": "Use this node format:\r\n \r\n {\r\n \"name\": \"New Node\",\r\n \"node_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/node_types/26000000000123\"\r\n },\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000123\"\r\n },\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n }", "input": [ { "name": "id", "type": "number", "info": "Node id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1NodesId" }, "task": true }, { "name": "rESTfulNodesDelete", "summary": "Deletes a node.", "description": "Deletes a node.", "input": [ { "name": "id", "type": "number", "info": "Node id.: 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": "/rESTfulNodesDelete" }, "task": true }, { "name": "rESTfulNodesGetAliases", "summary": "Gets the collection of node aliases.", "description": "Gets the collection of node aliases.", "input": [ { "name": "masterNodeId", "type": "number", "info": "Id of a node to get aliases for.: 123", "required": true, "schema": { "title": "masterNodeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodesGetAliases" }, "task": true }, { "name": "rESTfulNodesPostAlias", "summary": "Creates a node alias.", "description": "Use this node format for new node creation:\r\n \r\n {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000000321\"\r\n }\r\n }", "input": [ { "name": "masterNodeId", "type": "number", "info": "Master node id.: 123", "required": true, "schema": { "title": "masterNodeId", "type": "number" } }, { "name": "body", "type": "object", "info": "New node alias.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodesPostAlias" }, "task": true }, { "name": "putWapiV1NodesSeparateLinks", "summary": "Visually separates all links between given nodes.", "description": "Use this format for links separation:\r\n \r\n {\r\n \"node_1\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028506\"\r\n },\r\n \"node_2\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028507\"\r\n },\r\n \"distance\": 50,\r\n \"bend_points_number\": 4,\r\n \"is_curved\": true\r\n }", "input": [ { "name": "visLinksSepartionData", "type": "object", "info": "Separation parameters.: {\"node_1\": {\"href\": \"string\"}, \"node_2\": {\"href\": \"string\"}, \"distance\": 123, \"bend_points_number\": 123, \"is_curved\": \"boolean\"}", "required": true, "schema": { "type": "object", "properties": { "node_1": { "type": "object", "properties": { "href": { "type": "string" } } }, "node_2": { "type": "object", "properties": { "href": { "type": "string" } } }, "distance": { "type": "number" }, "bend_points_number": { "type": "integer" }, "is_curved": { "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": "/putWapiV1NodesSeparateLinks" }, "task": true }, { "name": "rESTfulDiagramSettingsGetDiagramSettings", "summary": "Gets the node diagram settings.", "description": "Node id example: 24000000000123", "input": [ { "name": "id", "type": "number", "info": "Node (diagram) id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "url": { "type": "string" }, "background": { "type": "string" }, "is_template": { "type": "boolean" }, "template": { "type": "object", "properties": { "href": { "type": "string" } } }, "page_color": { "type": "string" }, "diagram_width": { "type": "number" }, "diagram_height": { "type": "number" }, "diagram_margin_size": { "type": "number" }, "is_blocked": { "type": "boolean" }, "visibility_layers_settings": { "type": "string" }, "auto_layout_state": { "type": "integer" }, "map_coord_left": { "type": "number" }, "map_coord_top": { "type": "number" }, "map_coord_right": { "type": "number" }, "map_coord_bottom": { "type": "number" }, "map_units_type": { "type": "integer" }, "map_source": { "type": "integer" }, "is_display_grid": { "type": "boolean" }, "is_snap_to_grid": { "type": "boolean" }, "grid_spacing_x": { "type": "number" }, "grid_spacing_y": { "type": "number" }, "read_only_for_non_admins": { "type": "boolean" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDiagramSettingsGetDiagramSettings" }, "task": true }, { "name": "rESTfulDiagramSettingsPut", "summary": "Updates diagram settings of an existing node.", "description": "Use this format for diagram settings update:\r\n \r\n {\r\n \"page_color\": \"#ffffff\",\r\n \"diagram_width\": 1100,\r\n \"diagram_height\": 850,\r\n \"diagram_margin_size\": 50,\r\n \"is_blocked\": false,\r\n \"is_hidden\": \"\",\r\n \"auto_layout_state\": 0,\r\n \"map_coord_left\": 0,\r\n \"map_coord_top\": 0,\r\n \"map_coord_right\": 0,\r\n \"map_coord_bottom\": 0,\r\n ...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Node id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node's diagram settings.: {\"url\": \"string\", \"background\": \"string\", \"is_template\": \"boolean\", \"template\": {\"href\": \"string\"}, \"page_color\": \"string\", \"diagram_width\": 123, \"diagram_height\": 123, \"diagram_margin_size\": 123, \"is_blocked\": \"boolean\", \"visibility_layers_settings\": \"string\", \"auto_layout_state\": 123, \"map_coord_left\": 123, \"map_coord_top\": 123, \"map_coord_right\": 123, \"map_coord_bottom\": 123, \"map_units_type\": 123, \"map_source\": 123, \"is_display_grid\": \"boolean\", \"is_snap_to_grid\": \"boolean\", \"grid_spacing_x\": 123, \"grid_spacing_y\": 123, \"read_only_for_non_admins\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "url": { "type": "string" }, "background": { "type": "string" }, "is_template": { "type": "boolean" }, "template": { "type": "object", "properties": { "href": { "type": "string" } } }, "page_color": { "type": "string" }, "diagram_width": { "type": "number" }, "diagram_height": { "type": "number" }, "diagram_margin_size": { "type": "number" }, "is_blocked": { "type": "boolean" }, "visibility_layers_settings": { "type": "string" }, "auto_layout_state": { "type": "integer" }, "map_coord_left": { "type": "number" }, "map_coord_top": { "type": "number" }, "map_coord_right": { "type": "number" }, "map_coord_bottom": { "type": "number" }, "map_units_type": { "type": "integer" }, "map_source": { "type": "integer" }, "is_display_grid": { "type": "boolean" }, "is_snap_to_grid": { "type": "boolean" }, "grid_spacing_x": { "type": "number" }, "grid_spacing_y": { "type": "number" }, "read_only_for_non_admins": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulDiagramSettingsPut" }, "task": true }, { "name": "rESTfulNodeMapCoordinatesGetMapCoordinates", "summary": "Gets the node map coordinates.", "description": "A node has map coordinates only when placed on a map diagram.", "input": [ { "name": "id", "type": "number", "info": "Node id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "units": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeMapCoordinatesGetMapCoordinates" }, "task": true }, { "name": "rESTfulNodeMapCoordinatesPut", "summary": "Updates map coordinates of an existing node.", "description": "Use this format for map coordinates update:\r\n \r\n {\r\n \"x\": 12.02441354,\r\n \"y\": -34.56026252\r\n \"units\": \"DynamicLatLon\"\r\n } \r\n Coordinates should be set in degrees.", "input": [ { "name": "id", "type": "number", "info": "Node id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated node's map coordinates.: {\"x\": 123, \"y\": 123, \"units\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "units": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulNodeMapCoordinatesPut" }, "task": true }, { "name": "rESTfulVisNodesGet", "summary": "Gets the vis nodes collection.", "description": "Gets the vis nodes collection.", "input": [ { "name": "nodeId", "type": "number", "info": "Parent node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodesGet" }, "task": true }, { "name": "rESTfulVisNodesPut", "summary": "Updates an existing vis node.", "description": "Use this format for vis node update:\r\n \r\n {\r\n \"x\": 198,\r\n \"y\": 240,\r\n \"width\": 50,\r\n \"height\": 50,\r\n \"is_keep_aspect_ratio\": false,\r\n \"can_move\": true,\r\n \"can_resize\": true,\r\n \"can_rotate\": true,\r\n \"can_delete\": true,\r\n \"is_hidden\": false,\r\n \"z_order\": 0,\r\n \"angle\": 0,\r\n \"href\": \"http://172.30...(description truncated)", "input": [ { "name": "visNode", "type": "object", "info": "Updated vis node.: {\"parent_diagram\": {\"href\": \"string\"}, \"displayed_fields\": {\"href\": \"string\"}, \"visual_override\": {\"href\": \"string\"}, \"is_reference_node\": \"boolean\", \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"image_override\": \"string\", \"is_keep_aspect_ratio\": \"boolean\", \"can_move\": \"boolean\", \"can_resize\": \"boolean\", \"can_rotate\": \"boolean\", \"can_delete\": \"boolean\", \"is_hidden\": \"boolean\", \"z_order\": 123, \"angle\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "displayed_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "visual_override": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_reference_node": { "type": "boolean" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "image_override": { "type": "string" }, "is_keep_aspect_ratio": { "type": "boolean" }, "can_move": { "type": "boolean" }, "can_resize": { "type": "boolean" }, "can_rotate": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "is_hidden": { "type": "boolean" }, "z_order": { "type": "integer" }, "angle": { "type": "integer" }, "href": { "type": "string" } } } }, { "name": "nodeId", "type": "string", "info": ": string", "required": true, "schema": { "title": "nodeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodesPut" }, "task": true }, { "name": "rESTfulVisNodesGetById", "summary": "Gets the vis node.", "description": "Node id example: 24000000000123, Vis Node id example: 123", "input": [ { "name": "nodeId", "type": "number", "info": "Parent node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Vis Node id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "displayed_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "visual_override": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_reference_node": { "type": "boolean" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "image_override": { "type": "string" }, "is_keep_aspect_ratio": { "type": "boolean" }, "can_move": { "type": "boolean" }, "can_resize": { "type": "boolean" }, "can_rotate": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "is_hidden": { "type": "boolean" }, "z_order": { "type": "integer" }, "angle": { "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodesGetById" }, "task": true }, { "name": "rESTfulVisNodesGetOriginal", "summary": "Gets the original (non-reference) Vis Node of the specified node.", "description": "Node id example: 24000000000123", "input": [ { "name": "nodeId", "type": "number", "info": "Node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_diagram": { "type": "object", "properties": { "href": { "type": "string" } } }, "displayed_fields": { "type": "object", "properties": { "href": { "type": "string" } } }, "visual_override": { "type": "object", "properties": { "href": { "type": "string" } } }, "is_reference_node": { "type": "boolean" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "image_override": { "type": "string" }, "is_keep_aspect_ratio": { "type": "boolean" }, "can_move": { "type": "boolean" }, "can_resize": { "type": "boolean" }, "can_rotate": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "is_hidden": { "type": "boolean" }, "z_order": { "type": "integer" }, "angle": { "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodesGetOriginal" }, "task": true }, { "name": "rESTfulVisNodesGetReferences", "summary": "Gets the collection of reference vis nodes of the specified node.", "description": "Gets the collection of reference vis nodes of the specified node.", "input": [ { "name": "nodeId", "type": "number", "info": "Node id.: 123", "required": true, "schema": { "title": "nodeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodesGetReferences" }, "task": true }, { "name": "rESTfulRackContainerDesignsGet", "summary": "Gets the container designs collection with no relation to a specific a rack type.", "description": "This collection is useful when direct access to rack type container designs is\r\n needed. For example, to find containers of certain capacity.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackContainerDesignsGet" }, "task": true }, { "name": "rESTfulRackContainerDesignsPut", "summary": "Update a rack type's container design.", "description": "Use this container design format for container design update:\r\n \r\n {\r\n \"parent_rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000002663\"\r\n },\r\n \"name\": \"\",\r\n \"rack_units_capacity\": 44,\r\n \"rack_position_order\": \"TopToBottom\",\r\n \"physical_height\": 77.0,\r\n \"physical_width\": 19.0,\r\n \"x\": 413.875,\r\n \"y\": 24.3...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Rack type's container design body with updated data.: {\"parent_rack_type\": {\"href\": \"string\"}, \"name\": \"string\", \"rack_units_capacity\": 123, \"rack_position_order\": 123, \"physical_height\": 123, \"physical_width\": 123, \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_rack_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "rack_units_capacity": { "type": "integer" }, "rack_position_order": { "enum": [ 0, 1 ], "type": "integer" }, "physical_height": { "type": "number" }, "physical_width": { "type": "number" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackContainerDesignsPut" }, "task": true }, { "name": "rESTfulRackContainerDesignsPost", "summary": "Creates an new rack type's container design.", "description": "Use this rack type's container design format for rack type's container design creation:\r\n \r\n {\r\n \"parent_rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000002663\"\r\n },\r\n \"name\": \"\",\r\n \"rack_units_capacity\": 44,\r\n \"rack_position_order\": \"TopToBottom\",\r\n \"physical_height\": 77.0,\r\n \"physical_width\": 19.0,\r\n \"x\": 413.875,...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New rack type's container design body.: {\"parent_rack_type\": {\"href\": \"string\"}, \"name\": \"string\", \"rack_units_capacity\": 123, \"rack_position_order\": 123, \"physical_height\": 123, \"physical_width\": 123, \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_rack_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "rack_units_capacity": { "type": "integer" }, "rack_position_order": { "enum": [ 0, 1 ], "type": "integer" }, "physical_height": { "type": "number" }, "physical_width": { "type": "number" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackContainerDesignsPost" }, "task": true }, { "name": "rESTfulRackContainerDesignsGetById", "summary": "Gets the container design belonging to the rack type.", "description": "Rack type id example: 26000000014512", "input": [ { "name": "id", "type": "number", "info": "Container design id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_rack_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "rack_units_capacity": { "type": "integer" }, "rack_position_order": { "enum": [ 0, 1 ], "type": "integer" }, "physical_height": { "type": "number" }, "physical_width": { "type": "number" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackContainerDesignsGetById" }, "task": true }, { "name": "getWapiV1RackTypesRackTypeIdRackContainerDesigns", "summary": "Gets the container designs collection for a rack type.", "description": "Gets the container designs collection for a rack type.", "input": [ { "name": "rackTypeId", "type": "number", "info": "Host rack type id.: 123", "required": true, "schema": { "title": "rackTypeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1RackTypesRackTypeIdRackContainerDesigns" }, "task": true }, { "name": "postWapiV1RackTypesRackTypeIdRackContainerDesigns", "summary": "Creates an new rack type's container design.", "description": "Use this rack type's container design format for rack type's container design creation:\r\n \r\n {\r\n \"name\": \"\",\r\n \"rack_units_capacity\": 44,\r\n \"rack_position_order\": \"TopToBottom\",\r\n \"physical_height\": 77.0,\r\n \"physical_width\": 19.0,\r\n \"x\": 413.875,\r\n \"y\": 24.3987,\r\n \"width\": 172.459,\r\n \"height\": 699.639\r\n }", "input": [ { "name": "rackTypeId", "type": "number", "info": "Parent rack type id.: 123", "required": true, "schema": { "title": "rackTypeId", "type": "number" } }, { "name": "body", "type": "object", "info": "New rack type's container design body.: {\"parent_rack_type\": {\"href\": \"string\"}, \"name\": \"string\", \"rack_units_capacity\": 123, \"rack_position_order\": 123, \"physical_height\": 123, \"physical_width\": 123, \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_rack_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "rack_units_capacity": { "type": "integer" }, "rack_position_order": { "enum": [ 0, 1 ], "type": "integer" }, "physical_height": { "type": "number" }, "physical_width": { "type": "number" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postWapiV1RackTypesRackTypeIdRackContainerDesigns" }, "task": true }, { "name": "getWapiV1RackTypesRackTypeIdRackContainerDesignsId", "summary": "Gets the container design belonging to the rack type.", "description": "Rack type id example: 26000000014512", "input": [ { "name": "rackTypeId", "type": "number", "info": "Host rack type id.: 123", "required": true, "schema": { "title": "rackTypeId", "type": "number" } }, { "name": "id", "type": "number", "info": "Container design id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_rack_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "rack_units_capacity": { "type": "integer" }, "rack_position_order": { "enum": [ 0, 1 ], "type": "integer" }, "physical_height": { "type": "number" }, "physical_width": { "type": "number" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1RackTypesRackTypeIdRackContainerDesignsId" }, "task": true }, { "name": "putWapiV1RackTypesRackTypeIdRackContainerDesignsId", "summary": "Update a rack type's container design.", "description": "Use this container design format for container design update:\r\n \r\n {\r\n \"parent_rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000002663\"\r\n },\r\n \"name\": \"\",\r\n \"rack_units_capacity\": 44,\r\n \"rack_position_order\": \"TopToBottom\",\r\n \"physical_height\": 77.0,\r\n \"physical_width\": 19.0,\r\n \"x\": 413.875,\r\n \"y\": 24.3...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Container design id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "rackTypeId", "type": "number", "info": "Parent rack type id.: 123", "required": true, "schema": { "title": "rackTypeId", "type": "number" } }, { "name": "body", "type": "object", "info": "Rack type's container design body with updated data.: {\"parent_rack_type\": {\"href\": \"string\"}, \"name\": \"string\", \"rack_units_capacity\": 123, \"rack_position_order\": 123, \"physical_height\": 123, \"physical_width\": 123, \"x\": 123, \"y\": 123, \"width\": 123, \"height\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_rack_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "rack_units_capacity": { "type": "integer" }, "rack_position_order": { "enum": [ 0, 1 ], "type": "integer" }, "physical_height": { "type": "number" }, "physical_width": { "type": "number" }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1RackTypesRackTypeIdRackContainerDesignsId" }, "task": true }, { "name": "rESTfulRackContainerDesignsDelete", "summary": "Deletes the rack type's container design.", "description": "Deletes the rack type's container design.", "input": [ { "name": "id", "type": "number", "info": "Container design id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "rackTypeId", "type": "string", "info": ": string", "required": true, "schema": { "title": "rackTypeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackContainerDesignsDelete" }, "task": true }, { "name": "rESTfulRackTypesGet", "summary": "Gets the rack types collection.", "description": "Gets the rack types collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackTypesGet" }, "task": true }, { "name": "rESTfulRackTypesPut", "summary": "Updates an existing rack type.", "description": "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\n The type group of the rack type cannot be changed. \r\n When altering the name parameter (renaming the rack type) the new name must be\r\n unique. \r\n When changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated rack type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackTypesPut" }, "task": true }, { "name": "rESTfulRackTypesPost", "summary": "Creates an new rack type.", "description": "Use this rack types format for rack type create:\r\n \r\n {\r\n \"base_node_type\": {\r\n \"image\": \"MyRack.jpg\",\r\n \"is_favorite\": true,\r\n \"template\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/wapi/v1/nodes/24000000000123\"\r\n },\r\n },\r\n \"name\": \"My Rack\",\r\n \"background\": null,\r\n \"power\": 1200.0,\r\n \"max_weight\": 100....(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New rack type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackTypesPost" }, "task": true }, { "name": "rESTfulRackTypesGetById", "summary": "Gets the rack type.", "description": "Rack type id example: 26000000000123", "input": [ { "name": "id", "type": "number", "info": "Rack type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "base_node_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "background": { "type": "string" }, "rack_units_capacity": { "type": "integer" }, "power": { "type": "number" }, "max_weight": { "type": "number" }, "is_display_rack_lines": { "type": "boolean" }, "in_stock": { "type": "integer" }, "vendor": { "type": "object", "properties": { "href": { "type": "string" } } }, "rack_container_designs": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackTypesGetById" }, "task": true }, { "name": "putWapiV1RackTypesId", "summary": "Updates an existing rack type.", "description": "System types cannot be updated. The system parameter cannot be altered either.\r\n \r\n The type group of the rack type cannot be changed. \r\n When altering the name parameter (renaming the rack type) the new name must be\r\n unique. \r\n When changing the image or background parameters the image file\r\n corresponding to the new file name should already exist on the server. Use\r\n an empty string to remove the node icon or background image.\r\n \r...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Rack type id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated rack type.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1RackTypesId" }, "task": true }, { "name": "rESTfulRackTypesDelete", "summary": "Deletes a rack type.", "description": "Only types without associated racks can be deleted.", "input": [ { "name": "id", "type": "number", "info": "Rack type id.: 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": "/rESTfulRackTypesDelete" }, "task": true }, { "name": "rESTfulRacksGet", "summary": "Gets the racks collection.", "description": "Gets the racks collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRacksGet" }, "task": true }, { "name": "rESTfulRacksPost", "summary": "Creates a rack.", "description": "Use this node format for new rack creation:\r\n \r\n {\r\n \"name\": \"My Rack\",\r\n \"base_node\": {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010327\"\r\n },\r\n },\r\n \"rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000003399\"\r\n },\r\n \"power\": 1200,\r\n \"max_weig...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New rack.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRacksPost" }, "task": true }, { "name": "rESTfulRacksGetById", "summary": "Gets the rack.", "description": "Rack id example: 24000000000123", "input": [ { "name": "id", "type": "number", "info": "Rack id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "base_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "rack_type": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "available_rack_units": { "type": "number" }, "power": { "type": "number" }, "power_used": { "type": "number" }, "max_weight": { "type": "number" }, "weight_used": { "type": "number" }, "rack_containers": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRacksGetById" }, "task": true }, { "name": "rESTfulRacksPut", "summary": "Updates an existing rack.", "description": "Use this rack format for rack update:\r\n \r\n {\r\n \"name\": \"My Rack\",\r\n \"base_node\": {\r\n \"parent_diagram\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000010327\"\r\n },\r\n },\r\n \"rack_type\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/rack_types/26000000003399\"\r\n },\r\n \"power\": 1200,\r\n \"max_weight\": 1...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "Rack id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated rack.: }", "required": true, "schema": { "type": "object", "properties": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRacksPut" }, "task": true }, { "name": "rESTfulRacksDelete", "summary": "Deletes a rack.", "description": "Deletes a rack.", "input": [ { "name": "id", "type": "number", "info": "Rack id.: 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": "/rESTfulRacksDelete" }, "task": true }, { "name": "rESTfulRackContainersGet", "summary": "Gets the rack containers collection.", "description": "Gets the rack containers collection.", "input": [ { "name": "rackId", "type": "number", "info": "Parent rack id.: 123", "required": true, "schema": { "title": "rackId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackContainersGet" }, "task": true }, { "name": "rESTfulRackContainersGetById", "summary": "Gets the rack container.", "description": "Rack container id example: 39", "input": [ { "name": "rackId", "type": "number", "info": "Parent rack id.: 123", "required": true, "schema": { "title": "rackId", "type": "number" } }, { "name": "id", "type": "number", "info": "Rack container id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_rack": { "type": "object", "properties": { "href": { "type": "string" } } }, "rack_container_design": { "type": "object", "properties": { "href": { "type": "string" } } }, "mounted_devices": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRackContainersGetById" }, "task": true }, { "name": "rESTfulRolesGet", "summary": "Gets the user roles collection.", "description": "Gets the user roles collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRolesGet" }, "task": true }, { "name": "rESTfulRolesGetById", "summary": "Gets a user role.", "description": "User role id example: 13000000000003", "input": [ { "name": "id", "type": "number", "info": "User role id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "permissions": { "enum": [ 0, 1, 2, 3, 4, 5, 6, -1 ], "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulRolesGetById" }, "task": true }, { "name": "rESTfulSearchGet", "summary": "Search resources.", "description": "This search endpoint returns following types of objects: Node, Rack,\r\n Device, Card, Port, FreeText, Circuit, Strand, \r\n Link, Slot", "input": [ { "name": "q", "type": "string", "info": "Search query.: string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "parentDiagram", "type": "string", "info": "Optional. Specifies a parent diagram to search on. Should contain the diagram's href.: string", "required": false, "schema": { "title": "parentDiagram", "type": "string" } }, { "name": "includeSubdiagrams", "type": "boolean", "info": "If true, includes sub diagrams when 'parent_diagram' is set.: boolean", "required": false, "schema": { "title": "includeSubdiagrams", "type": "boolean" } }, { "name": "exactMatch", "type": "boolean", "info": "If true, the exact match criteria is used for searching.: boolean", "required": false, "schema": { "title": "exactMatch", "type": "boolean" } }, { "name": "resourceType", "type": "string", "info": "Restricts search results only by resources of this object type\r\n (see the remark for available object types).: string", "required": false, "schema": { "title": "resourceType", "type": "string" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage: 'resource' expands found resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulSearchGet" }, "task": true }, { "name": "rESTfulWorkOrderTasksGet", "summary": "Gets the work order task's collection with no relation to a specific work order.", "description": "Gets the work order task's collection with no relation to a specific work order.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrderTasksGet" }, "task": true }, { "name": "getWapiV1WorkOrdersWorkOrderIdTasks", "summary": "Gets the work order task's collection.", "description": "Gets the work order task's collection.", "input": [ { "name": "workOrderId", "type": "number", "info": "Host work order id.: 123", "required": true, "schema": { "title": "workOrderId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWapiV1WorkOrdersWorkOrderIdTasks" }, "task": true }, { "name": "rESTfulWorkOrderTasksPut", "summary": "Updates an existing work order task.", "description": "When altering the name parameter (renaming the work order task) the new name\r\n must be unique throughout work order tasks. \r\n Use this work order task format for work order task update:\r\n \r\n {\r\n \"performer\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000005\"\r\n },\r\n \"name\": \"Other Test New Name\",\r\n \"due_date\": \"2019-11-04T00:00:00\",\r\n \"comments\": \"\",\r\n ...(description truncated)", "input": [ { "name": "workOrderTask", "type": "object", "info": "Updated work order task.: {\"parent_work_order\": {\"href\": \"string\"}, \"performer\": {\"href\": \"string\"}, \"object\": {\"href\": \"string\"}, \"name\": \"string\", \"due_date\": \"string\", \"comments\": \"string\", \"type\": 123, \"status\": 123, \"is_performer_notified\": \"boolean\", \"is_performer_notified_about_overdue\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_work_order": { "type": "object", "properties": { "href": { "type": "string" } } }, "performer": { "type": "object", "properties": { "href": { "type": "string" } } }, "object": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "due_date": { "type": "string" }, "comments": { "type": "string" }, "type": { "enum": [ 0, 1, 2 ], "type": "integer" }, "status": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "is_performer_notified": { "type": "boolean" }, "is_performer_notified_about_overdue": { "type": "boolean" }, "href": { "type": "string" } } } }, { "name": "workOrderId", "type": "string", "info": ": string", "required": true, "schema": { "title": "workOrderId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrderTasksPut" }, "task": true }, { "name": "rESTfulWorkOrderTasksPost", "summary": "Creates a work order task.", "description": "New work order task name must be unique throughout work order tasks. \r\n Use this work order task format for new work order tasks creation:\r\n \r\n {\r\n \"parent_work_order\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/work_orders/1\"\r\n },\r\n \"performer\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000004\"\r\n },\r\n \"object\": {\r\n \"hr...(description truncated)", "input": [ { "name": "workOrderTask", "type": "object", "info": "New work order task.: {\"parent_work_order\": {\"href\": \"string\"}, \"performer\": {\"href\": \"string\"}, \"object\": {\"href\": \"string\"}, \"name\": \"string\", \"due_date\": \"string\", \"comments\": \"string\", \"type\": 123, \"status\": 123, \"is_performer_notified\": \"boolean\", \"is_performer_notified_about_overdue\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_work_order": { "type": "object", "properties": { "href": { "type": "string" } } }, "performer": { "type": "object", "properties": { "href": { "type": "string" } } }, "object": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "due_date": { "type": "string" }, "comments": { "type": "string" }, "type": { "enum": [ 0, 1, 2 ], "type": "integer" }, "status": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "is_performer_notified": { "type": "boolean" }, "is_performer_notified_about_overdue": { "type": "boolean" }, "href": { "type": "string" } } } }, { "name": "workOrderId", "type": "string", "info": ": string", "required": true, "schema": { "title": "workOrderId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrderTasksPost" }, "task": true }, { "name": "rESTfulWorkOrderTasksGetById", "summary": "Gets a work order task.", "description": "Work order task id example: 20008", "input": [ { "name": "workOrderId", "type": "number", "info": "Host work order id.: 123", "required": true, "schema": { "title": "workOrderId", "type": "number" } }, { "name": "id", "type": "number", "info": "Work order task id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_work_order": { "type": "object", "properties": { "href": { "type": "string" } } }, "performer": { "type": "object", "properties": { "href": { "type": "string" } } }, "object": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "due_date": { "type": "string" }, "comments": { "type": "string" }, "type": { "enum": [ 0, 1, 2 ], "type": "integer" }, "status": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "is_performer_notified": { "type": "boolean" }, "is_performer_notified_about_overdue": { "type": "boolean" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrderTasksGetById" }, "task": true }, { "name": "rESTfulWorkOrderTasksDelete", "summary": "Deletes a work order task.", "description": "Deletes a work order task.", "input": [ { "name": "id", "type": "number", "info": "Work order task id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "workOrderId", "type": "string", "info": ": string", "required": true, "schema": { "title": "workOrderId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrderTasksDelete" }, "task": true }, { "name": "rESTfulUsersGet", "summary": "Gets the netTerrain users collection.", "description": "Gets the netTerrain users collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulUsersGet" }, "task": true }, { "name": "rESTfulUsersPut", "summary": "Updates an existing user.", "description": "User name and type cannot be changed. \r\n Use this user format for user update:\r\n \r\n {\r\n \"is_override_ad_group\": false,\r\n \"name\": \"milton\",\r\n \"is_locked\": false,\r\n \"account_type\": \"NetTerrain\",\r\n \"email\": \"milton.waddams@initech.com\",\r\n \"description\": \"\",\r\n \"comments\": \"\",\r\n \"group\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/groups/120000000...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "Updated user.: {\"is_override_ad_group\": \"boolean\", \"name\": \"string\", \"is_locked\": \"boolean\", \"account_type\": 123, \"email\": \"string\", \"description\": \"string\", \"comments\": \"string\", \"group\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "is_override_ad_group": { "type": "boolean" }, "name": { "type": "string" }, "is_locked": { "type": "boolean" }, "account_type": { "enum": [ 0, 1, 3 ], "type": "integer" }, "email": { "type": "string" }, "description": { "type": "string" }, "comments": { "type": "string" }, "group": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulUsersPut" }, "task": true }, { "name": "rESTfulUsersPost", "summary": "Creates a user.", "description": "Use {M:NetTerrain.Controllers.RESTfulApi.RESTfulUsersController.SetPassword(System.Int64,System.String)} method to set a password for\r\n the newly created user. \r\n Use this user format for new users creation:\r\n \r\n {\r\n \"is_override_ad_group\": false,\r\n \"name\": \"milton\",\r\n \"is_locked\": false,\r\n \"account_type\": \"NetTerrain\",\r\n \"email\": \"milton.waddams@initech.com\",\r\n ...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "New user.: {\"is_override_ad_group\": \"boolean\", \"name\": \"string\", \"is_locked\": \"boolean\", \"account_type\": 123, \"email\": \"string\", \"description\": \"string\", \"comments\": \"string\", \"group\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "is_override_ad_group": { "type": "boolean" }, "name": { "type": "string" }, "is_locked": { "type": "boolean" }, "account_type": { "enum": [ 0, 1, 3 ], "type": "integer" }, "email": { "type": "string" }, "description": { "type": "string" }, "comments": { "type": "string" }, "group": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulUsersPost" }, "task": true }, { "name": "rESTfulUsersGetById", "summary": "Gets a netTerrain user.", "description": "User id example: 94000000000002", "input": [ { "name": "id", "type": "number", "info": "User id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "is_override_ad_group": { "type": "boolean" }, "name": { "type": "string" }, "is_locked": { "type": "boolean" }, "account_type": { "enum": [ 0, 1, 3 ], "type": "integer" }, "email": { "type": "string" }, "description": { "type": "string" }, "comments": { "type": "string" }, "group": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulUsersGetById" }, "task": true }, { "name": "putWapiV1UsersId", "summary": "Updates an existing user.", "description": "User name and type cannot be changed. \r\n Use this user format for user update:\r\n \r\n {\r\n \"is_override_ad_group\": false,\r\n \"name\": \"milton\",\r\n \"is_locked\": false,\r\n \"account_type\": \"NetTerrain\",\r\n \"email\": \"milton.waddams@initech.com\",\r\n \"description\": \"\",\r\n \"comments\": \"\",\r\n \"group\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/groups/120000000...(description truncated)", "input": [ { "name": "id", "type": "number", "info": "User id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "body", "type": "object", "info": "Updated user.: {\"is_override_ad_group\": \"boolean\", \"name\": \"string\", \"is_locked\": \"boolean\", \"account_type\": 123, \"email\": \"string\", \"description\": \"string\", \"comments\": \"string\", \"group\": {\"href\": \"string\"}, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "is_override_ad_group": { "type": "boolean" }, "name": { "type": "string" }, "is_locked": { "type": "boolean" }, "account_type": { "enum": [ 0, 1, 3 ], "type": "integer" }, "email": { "type": "string" }, "description": { "type": "string" }, "comments": { "type": "string" }, "group": { "type": "object", "properties": { "href": { "type": "string" } } }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1UsersId" }, "task": true }, { "name": "rESTfulUsersDelete", "summary": "Deletes a user.", "description": "User id example: 94000000000032. \r\n \r\n Service account used for API authentication cannot be deleted this way.", "input": [ { "name": "id", "type": "number", "info": "User id.: 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": "/rESTfulUsersDelete" }, "task": true }, { "name": "rESTfulUsersSetPassword", "summary": "Sets a password for a user.", "description": "Password of current the account used for API authentication cannot be changed.\r\n \r\n \r\n \r\n Use a quoted string in the request body to represent a new password.\r\n (The body is represented by the 'password' parameter in the following form). It must look\r\n like this: \"MyNewPassword\". Including quotes! Do not use any brackets.", "input": [ { "name": "id", "type": "number", "info": "User id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "password", "type": "string", "info": "New password.: string", "required": true, "schema": { "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulUsersSetPassword" }, "task": true }, { "name": "rESTfulVendorsGet", "summary": "Gets the vendors collection.", "description": "Gets the vendors collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVendorsGet" }, "task": true }, { "name": "rESTfulVendorsPut", "summary": "Updates an existing vendor.", "description": "When altering the name parameter (renaming the vendor) the new name must be\r\n unique throughout vendors. \r\n Use this vendor format for vendor update:\r\n \r\n {\r\n \"name\": \"ACME\",\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/vendors/767\"\r\n }", "input": [ { "name": "vendor", "type": "object", "info": "Updated vendor.: {\"name\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVendorsPut" }, "task": true }, { "name": "rESTfulVendorsPost", "summary": "Creates a vendor.", "description": "New vendor name must be unique throughout vendors. \r\n Use this vendor format for new vendors creation:\r\n \r\n {\r\n \"name\": \"ACME\"\r\n }", "input": [ { "name": "vendor", "type": "object", "info": "New vendor.: {\"name\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVendorsPost" }, "task": true }, { "name": "rESTfulVendorsGetById", "summary": "Gets a vendor.", "description": "Vendor id example: 27000000000017", "input": [ { "name": "id", "type": "number", "info": "Vendor id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVendorsGetById" }, "task": true }, { "name": "putWapiV1VendorsId", "summary": "Updates an existing vendor.", "description": "When altering the name parameter (renaming the vendor) the new name must be\r\n unique throughout vendors. \r\n Use this vendor format for vendor update:\r\n \r\n {\r\n \"name\": \"ACME\"\r\n }", "input": [ { "name": "id", "type": "number", "info": "Vendor id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "vendor", "type": "object", "info": "Updated vendor.: {\"name\": \"string\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putWapiV1VendorsId" }, "task": true }, { "name": "rESTfulVendorsDelete", "summary": "Deletes a vendor.", "description": "Vendors in use cannot be deleted.", "input": [ { "name": "id", "type": "number", "info": "Vendor id.: 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": "/rESTfulVendorsDelete" }, "task": true }, { "name": "rESTfulVisLinkDisplayedFieldsGet", "summary": "Gets the vis link displayed fields collection.", "description": "Gets the vis link displayed fields collection.", "input": [ { "name": "visLinkId", "type": "number", "info": "Vis link id.: 123", "required": true, "schema": { "title": "visLinkId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisLinkDisplayedFieldsGet" }, "task": true }, { "name": "rESTfulVisLinkDisplayedFieldsPut", "summary": "Updates an existing displayed field of a vis link property value.", "description": "Use this displayed field format:\r\n \r\n {\r\n \"offset_x\": 50,\r\n \"offset_y\": 50,\r\n \"anchor\": 1,\r\n \"upright_alignment\": false,\r\n \"font_size\": 12,\r\n \"color\": \"#004020\",\r\n \"background_color\": \"#AAB456\",\r\n \"justification\": 1,\r\n \"can_move\": false,\r\n \"angle\": -34,\r\n \"is_displayed\": true,\r\n \"is_bold\": true,\r\n...(description truncated)", "input": [ { "name": "linkDisplayedField", "type": "object", "info": "Updated displayed field.: {\"parent_vis_link\": {\"href\": \"string\"}, \"parent_link_property_value\": {\"href\": \"string\"}, \"offset_x\": 123, \"offset_y\": 123, \"anchor\": 123, \"upright_alignment\": \"boolean\", \"font_size\": 123, \"color\": \"string\", \"background_color\": \"string\", \"justification\": 123, \"can_move\": \"boolean\", \"angle\": 123, \"is_displayed\": \"boolean\", \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underline\": \"boolean\", \"font_family\": \"string\", \"align\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_vis_link": { "type": "object", "properties": { "href": { "type": "string" } } }, "parent_link_property_value": { "type": "object", "properties": { "href": { "type": "string" } } }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "anchor": { "type": "integer" }, "upright_alignment": { "type": "boolean" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } }, { "name": "visLinkId", "type": "string", "info": ": string", "required": true, "schema": { "title": "visLinkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisLinkDisplayedFieldsPut" }, "task": true }, { "name": "rESTfulVisLinkDisplayedFieldsPost", "summary": "Creates a displayed field for a link's property value.", "description": "Use this format for displayed field creation:\r\n \r\n {\r\n \"parent_vis_link\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000007415/vis_links/7572\"\r\n },\r\n \"parent_link_property_value\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/links/25000000007415/link_property_values/15069\"\r\n },\r\n \"offset_x\": 70,\r\n \"offset_y\": 70,\r\n \"anc...(description truncated)", "input": [ { "name": "displayedField", "type": "object", "info": "New displayed field.: {\"parent_vis_link\": {\"href\": \"string\"}, \"parent_link_property_value\": {\"href\": \"string\"}, \"offset_x\": 123, \"offset_y\": 123, \"anchor\": 123, \"upright_alignment\": \"boolean\", \"font_size\": 123, \"color\": \"string\", \"background_color\": \"string\", \"justification\": 123, \"can_move\": \"boolean\", \"angle\": 123, \"is_displayed\": \"boolean\", \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underline\": \"boolean\", \"font_family\": \"string\", \"align\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_vis_link": { "type": "object", "properties": { "href": { "type": "string" } } }, "parent_link_property_value": { "type": "object", "properties": { "href": { "type": "string" } } }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "anchor": { "type": "integer" }, "upright_alignment": { "type": "boolean" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } }, { "name": "visLinkId", "type": "string", "info": ": string", "required": true, "schema": { "title": "visLinkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisLinkDisplayedFieldsPost" }, "task": true }, { "name": "rESTfulVisLinkDisplayedFieldsGetById", "summary": "Gets the vis link displayed field value.", "description": "Gets the vis link displayed field value.", "input": [ { "name": "linkPropertyValueId", "type": "number", "info": "Link property value id.: 123", "required": true, "schema": { "title": "linkPropertyValueId", "type": "number" } }, { "name": "visLinkId", "type": "number", "info": "Vis link id.: 123", "required": true, "schema": { "title": "visLinkId", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_vis_link": { "type": "object", "properties": { "href": { "type": "string" } } }, "parent_link_property_value": { "type": "object", "properties": { "href": { "type": "string" } } }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "anchor": { "type": "integer" }, "upright_alignment": { "type": "boolean" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisLinkDisplayedFieldsGetById" }, "task": true }, { "name": "rESTfulVisNodeDisplayedFieldsGet", "summary": "Gets the vis node displayed fields collection.", "description": "Gets the vis node displayed fields collection.", "input": [ { "name": "visNodeId", "type": "number", "info": "Vis node id.: 123", "required": true, "schema": { "title": "visNodeId", "type": "number" } }, { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodeDisplayedFieldsGet" }, "task": true }, { "name": "rESTfulVisNodeDisplayedFieldsPut", "summary": "Updates an existing displayed field of a vis node property value.", "description": "Use this displayed field format:\r\n \r\n {\r\n \"offset_x\": 10,\r\n \"offset_y\": -25,\r\n \"font_size\": 12,\r\n \"color\": \"#450450\",\r\n \"background_color\": \"#AAAAAA\",\r\n \"justification\": 1,\r\n \"can_move\": false,\r\n \"angle\": 278,\r\n \"is_displayed\": true,\r\n \"is_bold\": true,\r\n \"is_italic\": true,\r\n \"is_underline\": true,\r\n ...(description truncated)", "input": [ { "name": "nodeDisplayedField", "type": "object", "info": "Updated displayed field.: {\"parent_vis_node\": {\"href\": \"string\"}, \"parent_node_property_value\": {\"href\": \"string\"}, \"offset_x\": 123, \"offset_y\": 123, \"font_size\": 123, \"color\": \"string\", \"background_color\": \"string\", \"justification\": 123, \"can_move\": \"boolean\", \"angle\": 123, \"is_displayed\": \"boolean\", \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underline\": \"boolean\", \"font_family\": \"string\", \"align\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_vis_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "parent_node_property_value": { "type": "object", "properties": { "href": { "type": "string" } } }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } }, { "name": "visNodeId", "type": "string", "info": ": string", "required": true, "schema": { "title": "visNodeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodeDisplayedFieldsPut" }, "task": true }, { "name": "rESTfulVisNodeDisplayedFieldsPost", "summary": "Creates a displayed field for a node's property value.", "description": "Use this format for displayed field creation:\r\n \r\n {\r\n \"parent_vis_node\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028497/vis_nodes/26341\"\r\n },\r\n \"parent_node_property_value\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/nodes/24000000028497/node_property_values/82769\"\r\n },\r\n \"offset_x\": 10,\r\n \"offset_y\": -25,\r\n \"font_si...(description truncated)", "input": [ { "name": "displayedField", "type": "object", "info": "New displayed field.: {\"parent_vis_node\": {\"href\": \"string\"}, \"parent_node_property_value\": {\"href\": \"string\"}, \"offset_x\": 123, \"offset_y\": 123, \"font_size\": 123, \"color\": \"string\", \"background_color\": \"string\", \"justification\": 123, \"can_move\": \"boolean\", \"angle\": 123, \"is_displayed\": \"boolean\", \"is_bold\": \"boolean\", \"is_italic\": \"boolean\", \"is_underline\": \"boolean\", \"font_family\": \"string\", \"align\": 123, \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "parent_vis_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "parent_node_property_value": { "type": "object", "properties": { "href": { "type": "string" } } }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } }, { "name": "visNodeId", "type": "string", "info": ": string", "required": true, "schema": { "title": "visNodeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodeDisplayedFieldsPost" }, "task": true }, { "name": "rESTfulVisNodeDisplayedFieldsGetById", "summary": "Gets the vis node displayed field value.", "description": "Gets the vis node displayed field value.", "input": [ { "name": "nodePropertyValueId", "type": "number", "info": "Node property value id.: 123", "required": true, "schema": { "title": "nodePropertyValueId", "type": "number" } }, { "name": "visNodeId", "type": "number", "info": "Vis node id.: 123", "required": true, "schema": { "title": "visNodeId", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "parent_vis_node": { "type": "object", "properties": { "href": { "type": "string" } } }, "parent_node_property_value": { "type": "object", "properties": { "href": { "type": "string" } } }, "offset_x": { "type": "number" }, "offset_y": { "type": "number" }, "font_size": { "type": "number" }, "color": { "type": "string" }, "background_color": { "type": "string" }, "justification": { "type": "integer" }, "can_move": { "type": "boolean" }, "angle": { "type": "integer" }, "is_displayed": { "type": "boolean" }, "is_bold": { "type": "boolean" }, "is_italic": { "type": "boolean" }, "is_underline": { "type": "boolean" }, "font_family": { "type": "string" }, "align": { "type": "integer" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulVisNodeDisplayedFieldsGetById" }, "task": true }, { "name": "rESTfulWorkOrdersGet", "summary": "Gets the work order's collection.", "description": "Gets the work order's collection.", "input": [ { "name": "page", "type": "number", "info": "Collection page number starting from 1.: 123", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "perPage", "type": "number", "info": "Resources per page.: 123", "required": false, "schema": { "title": "perPage", "type": "number" } }, { "name": "offset", "type": "number", "info": "Resources to skip before the first page starts.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'self' expands collection items,\r\n 'self,child_resource_name,...' also expands child resources with names set.\r\n ...(description truncated): string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrdersGet" }, "task": true }, { "name": "rESTfulWorkOrdersPut", "summary": "Updates an existing work order.", "description": "When altering the name parameter (renaming the work order) the new name must be\r\n unique throughout work orders. \r\n Use this work order format for work order update:\r\n \r\n {\r\n \"owner\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000005\"\r\n },\r\n \"name\": \"WO#3-Urgent!\",\r\n \"due_date\": \"2019-02-01\",\r\n \"comments\": \"Urgent!\",\r\n \"is_archived\": false,\r\n ...(description truncated)", "input": [ { "name": "workOrder", "type": "object", "info": "Updated work order.: {\"owner\": {\"href\": \"string\"}, \"name\": \"string\", \"due_date\": \"string\", \"comments\": \"string\", \"is_archived\": \"boolean\", \"is_owner_notified\": \"boolean\", \"is_owner_notified_about_overdue\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "due_date": { "type": "string" }, "comments": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_owner_notified": { "type": "boolean" }, "is_owner_notified_about_overdue": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrdersPut" }, "task": true }, { "name": "rESTfulWorkOrdersPost", "summary": "Creates a work order.", "description": "New work order name must be unique throughout work orders. \r\n Use this work order format for new work orders creation:\r\n \r\n {\r\n \"owner\": {\r\n \"href\": \"http://172.30.1.110:80/vis/wapi/v1/users/94000000000005\"\r\n },\r\n \"name\": \"WO#1\",\r\n \"due_date\": \"2019-04-18\",\r\n \"comments\": \"New work order\"\r\n }", "input": [ { "name": "workOrder", "type": "object", "info": "New work order.: {\"owner\": {\"href\": \"string\"}, \"name\": \"string\", \"due_date\": \"string\", \"comments\": \"string\", \"is_archived\": \"boolean\", \"is_owner_notified\": \"boolean\", \"is_owner_notified_about_overdue\": \"boolean\", \"href\": \"string\"}", "required": true, "schema": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "due_date": { "type": "string" }, "comments": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_owner_notified": { "type": "boolean" }, "is_owner_notified_about_overdue": { "type": "boolean" }, "href": { "type": "string" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrdersPost" }, "task": true }, { "name": "rESTfulWorkOrdersGetById", "summary": "Gets a work order.", "description": "Work order id example: 7", "input": [ { "name": "id", "type": "number", "info": "Work order id.: 123", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "expand", "type": "string", "info": "Data expansion. Usage:\r\n 'child_resource_name,...' expands child resources with names set.\r\n 'all_children' expands all child resources.: string", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "showChildCollections", "type": "boolean", "info": "If unset or set to false all unexpanded child\r\n collections contain just a single \"href\" link. Otherwise they also contain basic collection\r\n info.: boolean", "required": false, "schema": { "title": "showChildCollections", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "owner": { "type": "object", "properties": { "href": { "type": "string" } } }, "name": { "type": "string" }, "due_date": { "type": "string" }, "comments": { "type": "string" }, "is_archived": { "type": "boolean" }, "is_owner_notified": { "type": "boolean" }, "is_owner_notified_about_overdue": { "type": "boolean" }, "href": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/rESTfulWorkOrdersGetById" }, "task": true }, { "name": "rESTfulWorkOrdersDelete", "summary": "Deletes a work order.", "description": "Work orders in use cannot be deleted.", "input": [ { "name": "id", "type": "number", "info": "Work order id.: 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": "/rESTfulWorkOrdersDelete" }, "task": true } ], "views": [] }