{ "id": "@itentialopensource/adapter-solarwinds_servicedesk", "type": "Adapter", "export": "SolarwindsServiceDesk", "title": "SolarwindsServiceDesk", "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": "getIncidentById", "summary": "Get incident", "description": "Get incident", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "incident": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Incident Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "due_at": { "type": "string", "example": "Jan 01,2025" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "origin": { "type": "string", "example": "api" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "is_service_request": { "type": "boolean", "example": true }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\"" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIncidentById" }, "task": true }, { "name": "updateIncidentById", "summary": "Update incident with specified fields", "description": "Update incident with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Incident fields to update: {\"incident\": {\"name\": \"string\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"description\": \"string\", \"state_id\": \"undefined\", \"assignee\": \"object\", \"assignee_id\": \"undefined\", \"priority\": \"undefined\", \"requester\": \"object\", \"category\": \"object\", \"subcategory\": \"object\", \"due_at\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incidents\": \"undefined\", \"solutions\": \"undefined\", \"changes\": \"undefined\", \"problems\": \"undefined\", \"releases\": \"undefined\", \"configuration_item_ids\": \"array\", \"cc\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "incident": { "type": "object", "properties": { "name": { "type": "string", "example": "Incident Name" }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "description": { "type": "string", "example": "description" }, "state_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "priority": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "category": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "subcategory": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "due_at": { "type": "string", "example": "Jan 01,2025" }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incidents": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "solutions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "changes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "problems": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "releases": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\"" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "incident": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Incident Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "due_at": { "type": "string", "example": "Jan 01,2025" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "origin": { "type": "string", "example": "api" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "is_service_request": { "type": "boolean", "example": true }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\"" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateIncidentById" }, "task": true }, { "name": "deleteIncidentById", "summary": "Delete incident", "description": "Delete incident", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteIncidentById" }, "task": true }, { "name": "getIncidents", "summary": "List of incidents", "description": "List of incidents", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of incidents", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "incident": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Incident Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "due_at": { "type": "string", "example": "Jan 01,2025" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "origin": { "type": "string", "example": "api" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "is_service_request": { "type": "boolean", "example": true }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\"" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getIncidents" }, "task": true }, { "name": "createIncident", "summary": "Create new incident", "description": "Create new incident", "input": [ { "name": "body", "type": "object", "info": "Incident fields to fill: {\"incident\": {\"name\": \"string\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"description\": \"string\", \"state_id\": \"undefined\", \"assignee\": \"object\", \"assignee_id\": \"undefined\", \"priority\": \"undefined\", \"requester\": \"object\", \"category\": \"object\", \"subcategory\": \"object\", \"due_at\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incidents\": \"undefined\", \"solutions\": \"undefined\", \"changes\": \"undefined\", \"problems\": \"undefined\", \"releases\": \"undefined\", \"configuration_item_ids\": \"array\", \"cc\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "incident": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Incident Name" }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "description": { "type": "string", "example": "description" }, "state_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "priority": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "category": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "subcategory": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "due_at": { "type": "string", "example": "Jan 01,2025" }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incidents": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "solutions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "changes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "problems": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "releases": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\"" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "incident": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Incident Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "due_at": { "type": "string", "example": "Jan 01,2025" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "origin": { "type": "string", "example": "api" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "is_service_request": { "type": "boolean", "example": true }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\"" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createIncident" }, "task": true }, { "name": "getProblemById", "summary": "Get problem", "description": "Get problem", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "problem": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Problem Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "root_cause": { "type": "string", "example": "Root cause description" }, "symptoms": { "type": "string", "example": "Symptoms description" }, "workaround": { "type": "string", "example": "Workaround description" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getProblemById" }, "task": true }, { "name": "updateProblemById", "summary": "Update problem with specified fields", "description": "Update problem with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Problem fields to update: {\"problem\": {\"name\": \"string\", \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"requester\": \"object\", \"assignee\": \"object\", \"priority\": \"string\", \"root_cause\": \"string\", \"symptoms\": \"string\", \"workaround\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incident_ids\": \"array\", \"itsm_change_ids\": \"array\", \"configuration_item_ids\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "problem": { "type": "object", "properties": { "name": { "type": "string", "example": "Problem Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "New" }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "priority": { "type": "string", "example": "High" }, "root_cause": { "type": "string", "example": "Root cause description" }, "symptoms": { "type": "string", "example": "Symptoms description" }, "workaround": { "type": "string", "example": "workaround description" }, "add_to_tag_list": { "type": "string", "example": "tag1" }, "remove_from_tag_list": { "type": "string", "example": "tag2" }, "tag_list": { "type": "string", "example": "tag1" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incident_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "itsm_change_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "problem": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Problem Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "root_cause": { "type": "string", "example": "Root cause description" }, "symptoms": { "type": "string", "example": "Symptoms description" }, "workaround": { "type": "string", "example": "Workaround description" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateProblemById" }, "task": true }, { "name": "deleteProblemById", "summary": "Delete problem", "description": "Delete problem", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteProblemById" }, "task": true }, { "name": "getProblems", "summary": "List of problems", "description": "List of problems", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of problems", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "problem": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Problem Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "root_cause": { "type": "string", "example": "Root cause description" }, "symptoms": { "type": "string", "example": "Symptoms description" }, "workaround": { "type": "string", "example": "Workaround description" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getProblems" }, "task": true }, { "name": "createProblem", "summary": "Create new problem", "description": "Create new problem", "input": [ { "name": "body", "type": "object", "info": "Problem fields to fill: {\"problem\": {\"name\": \"string\", \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"requester\": \"object\", \"assignee\": \"object\", \"priority\": \"string\", \"root_cause\": \"string\", \"symptoms\": \"string\", \"workaround\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incident_ids\": \"array\", \"itsm_change_ids\": \"array\", \"configuration_item_ids\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "problem": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Problem Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "New" }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "priority": { "type": "string", "example": "High" }, "root_cause": { "type": "string", "example": "Root cause description" }, "symptoms": { "type": "string", "example": "Symptoms description" }, "workaround": { "type": "string", "example": "workaround description" }, "add_to_tag_list": { "type": "string", "example": "tag1" }, "remove_from_tag_list": { "type": "string", "example": "tag2" }, "tag_list": { "type": "string", "example": "tag1" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incident_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "itsm_change_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "problem": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Problem Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "root_cause": { "type": "string", "example": "Root cause description" }, "symptoms": { "type": "string", "example": "Symptoms description" }, "workaround": { "type": "string", "example": "Workaround description" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createProblem" }, "task": true }, { "name": "getChangeById", "summary": "Get change", "description": "Get change", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "change": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Change Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getChangeById" }, "task": true }, { "name": "updateChangeById", "summary": "Update change with specified fields", "description": "Update change with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Change fields to update: {\"change\": {\"name\": \"string\", \"change_type\": 123, \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"requester\": \"object\", \"assignee\": \"object\", \"priority\": \"string\", \"change_plan\": \"string\", \"rollback_plan\": \"string\", \"test_plan\": \"string\", \"planned_start_at\": \"string\", \"planned_end_at\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incidents\": \"undefined\", \"problems\": \"undefined\", \"releases\": \"undefined\", \"configuration_item_ids\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "change": { "type": "object", "properties": { "name": { "type": "string", "example": "Change Name" }, "change_type": { "type": "integer", "example": 1 }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "New" }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "planned_start_at": { "type": "string", "example": "2025-01-01 00:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01 05:00" }, "add_to_tag_list": { "type": "string", "example": "tag1" }, "remove_from_tag_list": { "type": "string", "example": "tag2" }, "tag_list": { "type": "string", "example": "tag1" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incidents": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "problems": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "releases": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "change": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Change Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateChangeById" }, "task": true }, { "name": "deleteChangeById", "summary": "Delete change", "description": "Delete change", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteChangeById" }, "task": true }, { "name": "getChanges", "summary": "List of changes", "description": "List of changes", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of changes", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "change": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Change Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getChanges" }, "task": true }, { "name": "createChange", "summary": "Create new change", "description": "Create new change", "input": [ { "name": "body", "type": "object", "info": "Change fields to fill: {\"change\": {\"name\": \"string\", \"change_type\": 123, \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"requester\": \"object\", \"assignee\": \"object\", \"priority\": \"string\", \"change_plan\": \"string\", \"rollback_plan\": \"string\", \"test_plan\": \"string\", \"planned_start_at\": \"string\", \"planned_end_at\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incidents\": \"undefined\", \"problems\": \"undefined\", \"releases\": \"undefined\", \"configuration_item_ids\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "change": { "type": "object", "required": [ "name", "change_type" ], "properties": { "name": { "type": "string", "example": "Change Name" }, "change_type": { "type": "integer", "example": 1 }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "New" }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "planned_start_at": { "type": "string", "example": "2025-01-01 00:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01 05:00" }, "add_to_tag_list": { "type": "string", "example": "tag1" }, "remove_from_tag_list": { "type": "string", "example": "tag2" }, "tag_list": { "type": "string", "example": "tag1" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incidents": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "problems": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "releases": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } }, { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } ] }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "change": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Change Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createChange" }, "task": true }, { "name": "getChangeCatalogById", "summary": "Get change catalog", "description": "Get change catalog", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "change_catalog": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Change Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "Approved" }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "default_assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "show_in_portal": { "type": "boolean", "example": true } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getChangeCatalogById" }, "task": true }, { "name": "updateChangeCatalogById", "summary": "Update change catalog with specified fields", "description": "Update change catalog with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Change catalog fields to update: {\"change_catalog\": {\"name\": \"string\", \"change_type\": 123, \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"default_assignee_id\": \"undefined\", \"priority\": \"string\", \"change_plan\": \"string\", \"rollback_plan\": \"string\", \"test_plan\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"show_in_portal\": \"boolean\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "change_catalog": { "type": "object", "properties": { "name": { "type": "string", "example": "Change Name" }, "change_type": { "type": "integer", "example": 1 }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "Approved" }, "default_assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "add_to_tag_list": { "type": "string", "example": "tag1" }, "remove_from_tag_list": { "type": "string", "example": "tag2" }, "tag_list": { "type": "string", "example": "tag1" }, "show_in_portal": { "type": "boolean", "example": true } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "change_catalog": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Change Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "Approved" }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "default_assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "show_in_portal": { "type": "boolean", "example": true } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateChangeCatalogById" }, "task": true }, { "name": "deleteChangeCatalogById", "summary": "Delete change catalog", "description": "Delete change catalog", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteChangeCatalogById" }, "task": true }, { "name": "getChangeCatalogs", "summary": "List of change catalogs", "description": "List of change catalogs", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of change catalogs", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "change_catalog": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Change Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "Approved" }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "default_assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "show_in_portal": { "type": "boolean", "example": true } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getChangeCatalogs" }, "task": true }, { "name": "createChangeCatalog", "summary": "Create new change catalog", "description": "Create new change catalog", "input": [ { "name": "body", "type": "object", "info": "Change catalog fields to fill: {\"change_catalog\": {\"name\": \"string\", \"change_type\": 123, \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"default_assignee_id\": \"undefined\", \"priority\": \"string\", \"change_plan\": \"string\", \"rollback_plan\": \"string\", \"test_plan\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"show_in_portal\": \"boolean\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "change_catalog": { "type": "object", "required": [ "name", "change_type" ], "properties": { "name": { "type": "string", "example": "Change Name" }, "change_type": { "type": "integer", "example": 1 }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "Approved" }, "default_assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "add_to_tag_list": { "type": "string", "example": "tag1" }, "remove_from_tag_list": { "type": "string", "example": "tag2" }, "tag_list": { "type": "string", "example": "tag1" }, "show_in_portal": { "type": "boolean", "example": true } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "change_catalog": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Change Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "Approved" }, "priority": { "type": "string", "example": "High" }, "change_plan": { "type": "string", "example": "change plan" }, "rollback_plan": { "type": "string", "example": "rollback plan" }, "test_plan": { "type": "string", "example": "test plan" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "default_assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "show_in_portal": { "type": "boolean", "example": true } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createChangeCatalog" }, "task": true }, { "name": "getReleaseById", "summary": "Get release", "description": "Get release", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "release": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Release Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "plan": { "type": "string", "example": "plan description" }, "build": { "type": "string", "example": "build description" }, "deploy": { "type": "string", "example": "deploy description" }, "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "approvers": { "type": "array", "items": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getReleaseById" }, "task": true }, { "name": "updateReleaseById", "summary": "Update release with specified fields", "description": "Update release with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Release fields to update: {\"release\": {\"name\": \"string\", \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"requester\": \"object\", \"assignee\": \"object\", \"priority\": \"string\", \"plan\": \"string\", \"build\": \"string\", \"deploy\": \"string\", \"planned_start_at\": \"string\", \"planned_end_at\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"itsm_change_ids\": \"array\", \"configuration_item_ids\": \"array\", \"approval_levels_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "release": { "type": "object", "properties": { "name": { "type": "string", "example": "Release Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "New" }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "priority": { "type": "string", "example": "High" }, "plan": { "type": "string", "example": "plan description" }, "build": { "type": "string", "example": "build description" }, "deploy": { "type": "string", "example": "deploy description" }, "planned_start_at": { "type": "string", "example": "2025-01-01 00:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01 05:00" }, "add_to_tag_list": { "type": "string", "example": "tag1" }, "remove_from_tag_list": { "type": "string", "example": "tag2" }, "tag_list": { "type": "string", "example": "tag1" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "itsm_change_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "approval_levels_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "approver_ids": { "type": "string", "example": "1, 2" }, "approval_condition": { "type": "string", "example": "1" } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "approver_ids": { "type": "string", "example": "1, 2" }, "approval_condition": { "type": "string", "example": "1" } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "release": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Release Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "plan": { "type": "string", "example": "plan description" }, "build": { "type": "string", "example": "build description" }, "deploy": { "type": "string", "example": "deploy description" }, "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "approvers": { "type": "array", "items": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateReleaseById" }, "task": true }, { "name": "deleteReleaseById", "summary": "Delete release", "description": "Delete release", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteReleaseById" }, "task": true }, { "name": "getRelease", "summary": "List of release", "description": "List of release", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of releases", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "release": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Release Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "plan": { "type": "string", "example": "plan description" }, "build": { "type": "string", "example": "build description" }, "deploy": { "type": "string", "example": "deploy description" }, "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "approvers": { "type": "array", "items": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } } } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getRelease" }, "task": true }, { "name": "createRelease", "summary": "Create new release", "description": "Create new release", "input": [ { "name": "body", "type": "object", "info": "Release fields to fill: {\"release\": {\"name\": \"string\", \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"requester\": \"object\", \"assignee\": \"object\", \"priority\": \"string\", \"plan\": \"string\", \"build\": \"string\", \"deploy\": \"string\", \"planned_start_at\": \"string\", \"planned_end_at\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"itsm_change_ids\": \"array\", \"configuration_item_ids\": \"array\", \"approval_levels_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "release": { "type": "object", "required": [ "name", "requester" ], "properties": { "name": { "type": "string", "example": "Release Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "New" }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "priority": { "type": "string", "example": "High" }, "plan": { "type": "string", "example": "plan description" }, "build": { "type": "string", "example": "build description" }, "deploy": { "type": "string", "example": "deploy description" }, "planned_start_at": { "type": "string", "example": "2025-01-01 00:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01 05:00" }, "add_to_tag_list": { "type": "string", "example": "tag1" }, "remove_from_tag_list": { "type": "string", "example": "tag2" }, "tag_list": { "type": "string", "example": "tag1" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "itsm_change_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "approval_levels_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "approver_ids": { "type": "string", "example": "1, 2" }, "approval_condition": { "type": "string", "example": "1" } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "approver_ids": { "type": "string", "example": "1, 2" }, "approval_condition": { "type": "string", "example": "1" } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "release": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Release Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "plan": { "type": "string", "example": "plan description" }, "build": { "type": "string", "example": "build description" }, "deploy": { "type": "string", "example": "deploy description" }, "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "approvers": { "type": "array", "items": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRelease" }, "task": true }, { "name": "getSolutionById", "summary": "Get solution", "description": "Get solution", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "solution": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Solution Name" }, "description": { "type": "string", "example": "description" }, "creator": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSolutionById" }, "task": true }, { "name": "updateSolutionById", "summary": "Update solution with specified fields", "description": "Update solution with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Solution fields to update: {\"solution\": {\"name\": \"string\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"description\": \"string\", \"state\": \"string\", \"category\": \"object\", \"subcategory\": \"object\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incident_ids\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "solution": { "type": "object", "properties": { "name": { "type": "string", "example": "Solution Name" }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "description": { "type": "string", "example": "description" }, "state": { "type": "string", "example": "Approved" }, "category": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "subcategory": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incident_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "solution": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Solution Name" }, "description": { "type": "string", "example": "description" }, "creator": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSolutionById" }, "task": true }, { "name": "deleteSolutionById", "summary": "Delete solution", "description": "Delete solution", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSolutionById" }, "task": true }, { "name": "getSolutions", "summary": "List of solutions", "description": "List of solutions", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of solutions", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "solution": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Solution Name" }, "description": { "type": "string", "example": "description" }, "creator": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "origin": { "type": "string", "example": "api" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getSolutions" }, "task": true }, { "name": "createSolution", "summary": "Create new solution", "description": "Create new solution", "input": [ { "name": "body", "type": "object", "info": "solution fields to fill: {\"solution\": {\"name\": \"string\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"description\": \"string\", \"state\": \"string\", \"category\": \"object\", \"subcategory\": \"object\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incident_ids\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "solution": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Solution Name" }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "description": { "type": "string", "example": "description" }, "state": { "type": "string", "example": "Approved" }, "category": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "subcategory": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incident_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "solution": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Solution Name" }, "description": { "type": "string", "example": "description" }, "creator": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSolution" }, "task": true }, { "name": "getCatalogItemById", "summary": "Get catalog item", "description": "Get catalog item", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "catalog_item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "expected_delivery_time": { "type": "string", "example": "1 day" }, "currency": { "type": "string", "example": "USD" }, "price": { "type": "string", "example": "1" }, "show_price": { "type": "boolean", "example": true }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCatalogItemById" }, "task": true }, { "name": "updateCatalogItemById", "summary": "Update catalog item with specified fields", "description": "Update catalog item with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Catalog item fields to update: {\"catalog_item\": {\"name\": \"string\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"description\": \"string\", \"state\": \"string\", \"default_assignee_id\": \"undefined\", \"category\": \"object\", \"subcategory\": \"object\", \"expected_delivery_time\": \"string\", \"currency\": \"string\", \"price\": \"string\", \"show_price\": \"undefined\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "catalog_item": { "type": "object", "properties": { "name": { "type": "string", "example": "CI Name" }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "description": { "type": "string", "example": "description" }, "state": { "type": "string", "example": "Approved" }, "default_assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "category": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "subcategory": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "expected_delivery_time": { "type": "string", "example": "1 day" }, "currency": { "type": "string", "example": "USD" }, "price": { "type": "string", "example": "1" }, "show_price": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "boolean", "example": true } ] }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "catalog_item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "expected_delivery_time": { "type": "string", "example": "1 day" }, "currency": { "type": "string", "example": "USD" }, "price": { "type": "string", "example": "1" }, "show_price": { "type": "boolean", "example": true }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateCatalogItemById" }, "task": true }, { "name": "deleteCatalogItemById", "summary": "Delete catalog item", "description": "Delete catalog item", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCatalogItemById" }, "task": true }, { "name": "getCatalogItems", "summary": "List of catalog items", "description": "List of catalog items", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of catalog items", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "catalog_item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "expected_delivery_time": { "type": "string", "example": "1 day" }, "currency": { "type": "string", "example": "USD" }, "price": { "type": "string", "example": "1" }, "show_price": { "type": "boolean", "example": true }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "origin": { "type": "string", "example": "api" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getCatalogItems" }, "task": true }, { "name": "createCatalogItem", "summary": "Create new catalog item", "description": "Create new catalog item", "input": [ { "name": "body", "type": "object", "info": "Catalog Item fields to fill: {\"catalog_item\": {\"name\": \"string\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"description\": \"string\", \"state\": \"string\", \"default_assignee_id\": \"undefined\", \"category\": \"object\", \"subcategory\": \"object\", \"expected_delivery_time\": \"string\", \"currency\": \"string\", \"price\": \"string\", \"show_price\": \"undefined\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "catalog_item": { "type": "object", "required": [ "name", "category" ], "properties": { "name": { "type": "string", "example": "CI Name" }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "description": { "type": "string", "example": "description" }, "state": { "type": "string", "example": "Approved" }, "default_assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "category": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "subcategory": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "expected_delivery_time": { "type": "string", "example": "1 day" }, "currency": { "type": "string", "example": "USD" }, "price": { "type": "string", "example": "1" }, "show_price": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "boolean", "example": true } ] }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "catalog_item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "expected_delivery_time": { "type": "string", "example": "1 day" }, "currency": { "type": "string", "example": "USD" }, "price": { "type": "string", "example": "1" }, "show_price": { "type": "boolean", "example": true }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCatalogItem" }, "task": true }, { "name": "createServiceRequest", "summary": "Request a Service", "description": "Request a Service", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Service Request fields to fill: {\"incident\": {\"site_id\": \"undefined\", \"department_id\": \"undefined\", \"requester_name\": \"string\", \"priority\": \"string\", \"due_at\": \"string\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"request_variables_attributes\": \"undefined\"}}", "required": false, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "incident": { "type": "object", "properties": { "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "requester_name": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "priority": { "type": "string", "example": "High" }, "due_at": { "type": "string", "example": "Jan 01,2025" }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" }, "request_variables_attributes": { "anyOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Variable name" }, "value": { "type": "string", "example": "Content" }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } }, { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Variable name" }, "value": { "type": "string", "example": "Content" }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "incident": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Incident Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "New" }, "priority": { "type": "string", "example": "High" }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "subcategory": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Category / Subcategory name" }, "default_tags": { "type": "string", "example": "tag1, tag2" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "due_at": { "type": "string", "example": "Jan 01,2025" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "created_by": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "origin": { "type": "string", "example": "api" }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "solutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "is_service_request": { "type": "boolean", "example": true }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\"" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createServiceRequest" }, "task": true }, { "name": "getConfigurationItemById", "summary": "Get configuration item", "description": "Get configuration item", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "configuration_item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Building" }, "description": { "type": "string", "example": "Configuration Item - Building" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom": { "type": "boolean", "example": false }, "icon_name": { "type": "string", "example": "BUILDING" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" } } }, "type_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "Active" }, "manager_id": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "user_id": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfigurationItemById" }, "task": true }, { "name": "updateConfigurationItemById", "summary": "Update configuration item with specified fields", "description": "Update configuration item with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Configuration Item fields to update: {\"configuration_item\": {\"type\": \"object\", \"type_id\": \"undefined\", \"name\": \"string\", \"description\": \"string\", \"asset_tag\": \"string\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"manager\": \"object\", \"user\": \"object\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incident_ids\": \"array\", \"itsm_change_ids\": \"array\", \"problem_ids\": \"array\", \"purchase_order_ids\": \"array\", \"release_ids\": \"array\", \"configuration_item_ids\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "configuration_item": { "type": "object", "properties": { "type": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "type_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "asset_tag": { "type": "string", "example": "Configuration Item Tag" }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "Active" }, "manager": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "user": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incident_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "itsm_change_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "problem_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "purchase_order_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "release_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "configuration_item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Building" }, "description": { "type": "string", "example": "Configuration Item - Building" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom": { "type": "boolean", "example": false }, "icon_name": { "type": "string", "example": "BUILDING" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" } } }, "type_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "Active" }, "manager_id": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "user_id": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateConfigurationItemById" }, "task": true }, { "name": "deleteConfigurationItemById", "summary": "Delete configurationitem", "description": "Delete configurationitem", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteConfigurationItemById" }, "task": true }, { "name": "getConfigurationItems", "summary": "List of configuration items", "description": "List of configuration items", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of configuration items", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "configuration_item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Building" }, "description": { "type": "string", "example": "Configuration Item - Building" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom": { "type": "boolean", "example": false }, "icon_name": { "type": "string", "example": "BUILDING" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" } } }, "type_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "Active" }, "manager_id": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "user_id": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "origin": { "type": "string", "example": "api" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getConfigurationItems" }, "task": true }, { "name": "createConfigurationItem", "summary": "Create new configurationitem", "description": "Create new configurationitem", "input": [ { "name": "body", "type": "object", "info": "Configuration Item fields to fill: {\"configuration_item\": {\"type\": \"object\", \"type_id\": \"undefined\", \"name\": \"string\", \"description\": \"string\", \"asset_tag\": \"string\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"state\": \"string\", \"manager\": \"object\", \"user\": \"object\", \"add_to_tag_list\": \"string\", \"remove_from_tag_list\": \"string\", \"tag_list\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"incident_ids\": \"array\", \"itsm_change_ids\": \"array\", \"problem_ids\": \"array\", \"purchase_order_ids\": \"array\", \"release_ids\": \"array\", \"configuration_item_ids\": \"array\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "configuration_item": { "type": "object", "required": [ "name" ], "properties": { "type": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "type_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "asset_tag": { "type": "string", "example": "Configuration Item Tag" }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "state": { "type": "string", "example": "Active" }, "manager": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "user": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "add_to_tag_list": { "type": "string", "example": "tag1, tag2" }, "remove_from_tag_list": { "type": "string", "example": "tag3" }, "tag_list": { "type": "string", "example": "tag1, tag2" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "incident_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "itsm_change_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "problem_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "purchase_order_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "release_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "configuration_item_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "configuration_item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "CI Name" }, "description": { "type": "string", "example": "description" }, "type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Building" }, "description": { "type": "string", "example": "Configuration Item - Building" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom": { "type": "boolean", "example": false }, "icon_name": { "type": "string", "example": "BUILDING" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" } } }, "type_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "state": { "type": "string", "example": "Active" }, "manager_id": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "user_id": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "incidents": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "purchase_orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "configuration_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "href": { "type": "string", "example": "https://mydomain.com/object_type/1" } } } }, "origin": { "type": "string", "example": "api" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createConfigurationItem" }, "task": true }, { "name": "appendDependentAssets", "summary": "Append multiple dependent assets", "description": "Append multiple dependent assets", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Dependencies fields to fill: object", "required": false, "schema": { "type": "object", "xml": { "name": "/" }, "additionalProperties": { "type": "object", "properties": { "selected_ids": { "type": "object", "properties": { "configuration_items": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } }, "mobiles": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } }, "hardwares": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } }, "discovery_hardwares": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } }, "other_assets": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } }, "example": { "Child Of": { "selected_ids": { "configuration_items": [ 1 ] } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/appendDependentAssets" }, "task": true }, { "name": "deleteAssetLink", "summary": "Delete dpendency by id", "description": "Delete dpendency by id", "input": [ { "name": "body", "type": "object", "info": "Dependencies fields to fill: {\"assetLinkId\": \"undefined\", \"sourceId\": \"undefined\", \"sourceType\": \"string\"}", "required": false, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "assetLinkId": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ], "description": "The id of the dependency between the assets" }, "sourceId": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ], "description": "The id of the configuration item" }, "sourceType": { "type": "string", "example": "ConfigurationItem" } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAssetLink" }, "task": true }, { "name": "getUserById", "summary": "Get user", "description": "Get user", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "title": { "type": "string", "example": "Support Agent" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "phone": { "type": "string", "example": "+10000000" }, "mobile_phone": { "type": "string", "example": "+10000000" }, "role": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Requester" }, "description": { "type": "string", "example": "Requester role" }, "portal": { "type": "boolean", "example": true }, "show_my_tasks": { "type": "boolean", "example": true } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } }, "reports_to": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "group_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+00:00" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserById" }, "task": true }, { "name": "updateUserById", "summary": "Update user with specified fields", "description": "Update user with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "User fields to update: {\"user\": {\"name\": \"string\", \"title\": \"string\", \"email\": \"string\", \"disabled\": \"boolean\", \"phone\": \"string\", \"mobile_phone\": \"string\", \"role\": \"object\", \"site\": \"object\", \"department\": \"object\", \"reports_to\": \"undefined\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "user": { "type": "object", "properties": { "name": { "type": "string", "example": "John Doe" }, "title": { "type": "string", "example": "Support Agent" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "disabled": { "type": "boolean", "example": false }, "phone": { "type": "string", "example": "+10000000" }, "mobile_phone": { "type": "string", "example": "+10000000" }, "role": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "reports_to": { "oneOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "title": { "type": "string", "example": "Support Agent" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "phone": { "type": "string", "example": "+10000000" }, "mobile_phone": { "type": "string", "example": "+10000000" }, "role": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Requester" }, "description": { "type": "string", "example": "Requester role" }, "portal": { "type": "boolean", "example": true }, "show_my_tasks": { "type": "boolean", "example": true } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } }, "reports_to": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "group_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+00:00" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateUserById" }, "task": true }, { "name": "deleteUserById", "summary": "Delete user", "description": "Delete user", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUserById" }, "task": true }, { "name": "getUsers", "summary": "List of Users", "description": "List of Users", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of users", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "title": { "type": "string", "example": "Support Agent" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "phone": { "type": "string", "example": "+10000000" }, "mobile_phone": { "type": "string", "example": "+10000000" }, "role": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Requester" }, "description": { "type": "string", "example": "Requester role" }, "portal": { "type": "boolean", "example": true }, "show_my_tasks": { "type": "boolean", "example": true } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } }, "reports_to": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "group_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+00:00" } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUsers" }, "task": true }, { "name": "createUser", "summary": "Create new user", "description": "Create new user", "input": [ { "name": "body", "type": "object", "info": "User fields to fill: {\"user\": {\"name\": \"string\", \"title\": \"string\", \"email\": \"string\", \"disabled\": \"boolean\", \"phone\": \"string\", \"mobile_phone\": \"string\", \"role\": \"object\", \"site\": \"object\", \"department\": \"object\", \"reports_to\": \"undefined\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "user": { "type": "object", "required": [ "name", "email" ], "properties": { "name": { "type": "string", "example": "John Doe" }, "title": { "type": "string", "example": "Support Agent" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "disabled": { "type": "boolean", "example": false }, "phone": { "type": "string", "example": "+10000000" }, "mobile_phone": { "type": "string", "example": "+10000000" }, "role": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "reports_to": { "oneOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "title": { "type": "string", "example": "Support Agent" }, "email": { "type": "string", "format": "email", "example": "john.doe@email.com" }, "phone": { "type": "string", "example": "+10000000" }, "mobile_phone": { "type": "string", "example": "+10000000" }, "role": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Requester" }, "description": { "type": "string", "example": "Requester role" }, "portal": { "type": "boolean", "example": true }, "show_my_tasks": { "type": "boolean", "example": true } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } }, "reports_to": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "group_ids": { "type": "array", "items": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "xml": { "wrapped": true }, "description": "for xml requests, please add: type=\"array\", for example: 1" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+00:00" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createUser" }, "task": true }, { "name": "getSiteById", "summary": "Get site", "description": "Get site", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "site": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "location": { "type": "string", "example": "AUS" }, "description": { "type": "string", "example": "Description Austin TX, USA" }, "time_zone": { "type": "string", "example": "Texas" }, "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" }, "business_record": { "type": "string", "example": "1" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSiteById" }, "task": true }, { "name": "updateSiteById", "summary": "Update site with specified fields", "description": "Update site with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Site fields to update: {\"site\": {\"name\": \"string\", \"location\": \"string\", \"description\": \"string\", \"time_zone\": \"string\", \"language\": \"string\", \"manager_id\": \"undefined\", \"default_assignee_id\": \"undefined\", \"business_record\": {\"id\": \"undefined\"}}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "site": { "type": "object", "properties": { "name": { "type": "string", "example": "Austin TX, USA" }, "location": { "type": "string", "example": "AUS" }, "description": { "type": "string", "example": "Description Austin TX, USA" }, "time_zone": { "type": "string", "example": "Texas" }, "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" }, "manager_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ], "description": "user only, not group" }, "default_assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "business_record": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "site": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "location": { "type": "string", "example": "AUS" }, "description": { "type": "string", "example": "Description Austin TX, USA" }, "time_zone": { "type": "string", "example": "Texas" }, "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" }, "business_record": { "type": "string", "example": "1" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSiteById" }, "task": true }, { "name": "deleteSiteById", "summary": "Delete site", "description": "Delete site", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSiteById" }, "task": true }, { "name": "getSites", "summary": "List of Sites", "description": "List of Sites", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of sites", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "site": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "location": { "type": "string", "example": "AUS" }, "description": { "type": "string", "example": "Description Austin TX, USA" }, "time_zone": { "type": "string", "example": "Texas" }, "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" }, "business_record": { "type": "string", "example": "1" } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getSites" }, "task": true }, { "name": "createSite", "summary": "Create new site", "description": "Create new site", "input": [ { "name": "body", "type": "object", "info": "Site fields to fill: {\"site\": {\"name\": \"string\", \"location\": \"string\", \"description\": \"string\", \"time_zone\": \"string\", \"language\": \"string\", \"manager_id\": \"undefined\", \"default_assignee_id\": \"undefined\", \"business_record\": {\"id\": \"undefined\"}}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "site": { "type": "object", "required": [ "name", "location" ], "properties": { "name": { "type": "string", "example": "Austin TX, USA" }, "location": { "type": "string", "example": "AUS" }, "description": { "type": "string", "example": "Description Austin TX, USA" }, "time_zone": { "type": "string", "example": "Texas" }, "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" }, "manager_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ], "description": "user only, not group" }, "default_assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "business_record": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "site": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "location": { "type": "string", "example": "AUS" }, "description": { "type": "string", "example": "Description Austin TX, USA" }, "time_zone": { "type": "string", "example": "Texas" }, "language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" }, "business_record": { "type": "string", "example": "1" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSite" }, "task": true }, { "name": "getDepartmentById", "summary": "Get department", "description": "Get department", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "department": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDepartmentById" }, "task": true }, { "name": "updateDepartmentById", "summary": "Update department with specified fields", "description": "Update department with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Department fields to update: {\"department\": {\"name\": \"string\", \"description\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "department": { "type": "object", "properties": { "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "department": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateDepartmentById" }, "task": true }, { "name": "deleteDepartmentById", "summary": "Delete department", "description": "Delete department", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDepartmentById" }, "task": true }, { "name": "getDepartments", "summary": "List of Departments", "description": "List of Departments", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of departments", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "department": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getDepartments" }, "task": true }, { "name": "createDepartment", "summary": "Create new department", "description": "Create new department", "input": [ { "name": "body", "type": "object", "info": "Department fields to fill: {\"department\": {\"name\": \"string\", \"description\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "department": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "department": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDepartment" }, "task": true }, { "name": "getRoleById", "summary": "Get role", "description": "Get role", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "role": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support Agent" }, "description": { "type": "string", "example": "Support Agent role" }, "portal": { "type": "boolean", "example": true }, "show_my_tasks": { "type": "boolean", "example": false } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRoleById" }, "task": true }, { "name": "updateRoleById", "summary": "Update role with specified fields", "description": "Update role with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Role fields to update: {\"role\": {\"name\": \"string\", \"description\": \"string\", \"portal\": \"boolean\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "role": { "type": "object", "properties": { "name": { "type": "string", "example": "Support Agent" }, "description": { "type": "string", "example": "Support Agent role" }, "portal": { "type": "boolean", "example": true } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "role": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support Agent" }, "description": { "type": "string", "example": "Support Agent role" }, "portal": { "type": "boolean", "example": true }, "show_my_tasks": { "type": "boolean", "example": false } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRoleById" }, "task": true }, { "name": "deleteRoleById", "summary": "Delete role", "description": "Delete role", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRoleById" }, "task": true }, { "name": "getRoles", "summary": "List of roles", "description": "List of roles", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of roles", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "role": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support Agent" }, "description": { "type": "string", "example": "Support Agent role" }, "portal": { "type": "boolean", "example": true }, "show_my_tasks": { "type": "boolean", "example": false } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getRoles" }, "task": true }, { "name": "createRole", "summary": "Create new role", "description": "Create new role", "input": [ { "name": "body", "type": "object", "info": "Role fields to fill: {\"role\": {\"name\": \"string\", \"description\": \"string\", \"portal\": \"boolean\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "role": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Support Agent" }, "description": { "type": "string", "example": "Support Agent role" }, "portal": { "type": "boolean", "example": true } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "role": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support Agent" }, "description": { "type": "string", "example": "Support Agent role" }, "portal": { "type": "boolean", "example": true }, "show_my_tasks": { "type": "boolean", "example": false } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRole" }, "task": true }, { "name": "getGroupById", "summary": "Get group", "description": "Get group", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "group": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Group Name" }, "description": { "type": "string", "example": "Group Description" }, "is_user": { "type": "boolean", "example": false }, "reports_to": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } }, "send_notifications": { "type": "boolean", "example": true }, "memberships": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "string", "example": "John Doe" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getGroupById" }, "task": true }, { "name": "updateGroupById", "summary": "Update group with specified fields", "description": "Update group with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Group fields to update: {\"group\": {\"name\": \"string\", \"description\": \"string\", \"superviser_id\": \"undefined\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "group": { "type": "object", "properties": { "name": { "type": "string", "example": "Group Name" }, "description": { "type": "string", "example": "Group Description" }, "superviser_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "group": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Group Name" }, "description": { "type": "string", "example": "Group Description" }, "is_user": { "type": "boolean", "example": false }, "reports_to": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } }, "send_notifications": { "type": "boolean", "example": true }, "memberships": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "string", "example": "John Doe" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateGroupById" }, "task": true }, { "name": "deleteGroupById", "summary": "Delete group", "description": "Delete group", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGroupById" }, "task": true }, { "name": "getGroups", "summary": "List of groups", "description": "List of groups", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of groups", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "group": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Group Name" }, "description": { "type": "string", "example": "Group Description" }, "is_user": { "type": "boolean", "example": false }, "reports_to": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } }, "send_notifications": { "type": "boolean", "example": true }, "memberships": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "string", "example": "John Doe" } } } } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getGroups" }, "task": true }, { "name": "createGroup", "summary": "Create new group", "description": "Create new group", "input": [ { "name": "body", "type": "object", "info": "Group fields to fill: {\"group\": {\"name\": \"string\", \"description\": \"string\", \"superviser_id\": \"undefined\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "group": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Group Name" }, "description": { "type": "string", "example": "Group Description" }, "superviser_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "group": { "type": "object", "required": [ "name" ], "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Group Name" }, "description": { "type": "string", "example": "Group Description" }, "is_user": { "type": "boolean", "example": false }, "reports_to": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } }, "send_notifications": { "type": "boolean", "example": true }, "memberships": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "string", "example": "John Doe" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createGroup" }, "task": true }, { "name": "getCategoryById", "summary": "Get category", "description": "Get category", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Equipment" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_tags": { "type": "string", "example": "equipment" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCategoryById" }, "task": true }, { "name": "updateCategoryById", "summary": "Update category with specified fields", "description": "Update category with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Category fields to update: {\"category\": {\"name\": \"string\", \"parent\": \"object\", \"default_assignee_id\": \"undefined\", \"default_tags\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "category": { "type": "object", "properties": { "name": { "type": "string", "example": "Equipment" }, "parent": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ], "example": { "name": "Facilities" } }, "default_assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_tags": { "type": "string", "example": "equipment" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Equipment" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_tags": { "type": "string", "example": "equipment" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateCategoryById" }, "task": true }, { "name": "deleteCategoryById", "summary": "Delete category", "description": "Delete category", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCategoryById" }, "task": true }, { "name": "getCategories", "summary": "List of categories", "description": "List of categories", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of categories", "type": "array", "items": { "allOf": [ { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Equipment" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_tags": { "type": "string", "example": "equipment" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } ] } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getCategories" }, "task": true }, { "name": "createCategory", "summary": "Create new category", "description": "Create new category", "input": [ { "name": "body", "type": "object", "info": "Category fields to fill: {\"category\": {\"name\": \"string\", \"parent\": \"object\", \"default_assignee_id\": \"undefined\", \"default_tags\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "category": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Equipment" }, "parent": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ], "example": { "name": "Facilities" } }, "default_assignee_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_tags": { "type": "string", "example": "equipment" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Equipment" }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "default_tags": { "type": "string", "example": "equipment" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createCategory" }, "task": true }, { "name": "getHardwareById", "summary": "Get hardware", "description": "Get hardware", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "hardware": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Hardware Name" }, "ip": { "type": "string", "example": "0.0.0.0" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Laptop" } } }, "owner": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "notes": { "type": "string", "example": "Hardware notes" }, "barcode_encoding_format": { "type": "string", "example": "Code1A" }, "cpu": { "type": "string", "example": "hardware_cpu" }, "processor_speed": { "type": "string", "example": "processor_speed" }, "memory": { "type": "string", "example": "1024" }, "swap": { "type": "string", "example": "MB" }, "domain": { "type": "string", "example": "domain description" }, "operating_system": { "type": "string", "example": "Windows 10" }, "active_directory": { "type": "string", "example": "Workgroup of the OS" }, "address": { "type": "string", "example": "Site 1, Building 1, Department 1" }, "longitude": { "type": "string", "example": "0.000" }, "latitude": { "type": "string", "example": "0.000" }, "product_number": { "type": "integer", "example": 1 }, "bio": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "manufacturer": { "type": "string", "example": "Dell" }, "ssn": { "type": "string", "example": "1" }, "model": { "type": "string", "example": "model description" }, "version": { "type": "string", "example": "1" }, "bios_date": { "type": "string", "example": "2020-01-01 00:00" }, "reported_at": { "type": "string", "example": "2020-01-01 00:00" } } } }, "tag": { "type": "string", "example": "hardware tag" }, "asset_tag": { "type": "string", "example": "1" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getHardwareById" }, "task": true }, { "name": "updateHardwareById", "summary": "Update hardware with specified fields", "description": "Update hardware with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Hardware fields to update: {\"hardware\": {\"name\": \"string\", \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"category\": \"object\", \"ip_address\": \"string\", \"external_ip\": \"string\", \"status\": \"object\", \"technical_contact\": \"object\", \"owner\": \"object\", \"notes\": \"string\", \"barcode_encoding_format\": \"string\", \"cpu\": \"string\", \"memory\": \"undefined\", \"swap\": \"string\", \"domain\": \"string\", \"operating_system\": \"string\", \"active_directory\": \"string\", \"address\": \"string\", \"longitude\": \"string\", \"latitude\": \"string\", \"product_number\": \"undefined\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"bio\": {\"manufacturer\": \"string\", \"ssn\": \"undefined\", \"model\": \"string\", \"version\": \"undefined\", \"bios_date\": \"string\"}, \"tag\": \"string\", \"asset_tag\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "hardware": { "type": "object", "properties": { "name": { "type": "string", "example": "Hardware Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "category": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "ip_address": { "type": "string", "example": "0.0.0.0" }, "external_ip": { "type": "string", "example": "0.0.0.0" }, "status": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "technical_contact": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "owner": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "notes": { "type": "string", "example": "Hardware notes" }, "barcode_encoding_format": { "type": "string", "example": "Code1A" }, "cpu": { "type": "string", "example": "hardware_cpu" }, "memory": { "anyOf": [ { "type": "string", "example": "1024" }, { "type": "integer", "example": 1024 } ] }, "swap": { "type": "string", "example": "MB" }, "domain": { "type": "string", "example": "domain description" }, "operating_system": { "type": "string", "example": "Windows 10" }, "active_directory": { "type": "string", "example": "Workgroup of the OS" }, "address": { "type": "string", "example": "Site 1, Building 1, Department 1" }, "longitude": { "type": "string", "example": "0.000" }, "latitude": { "type": "string", "example": "0.000" }, "product_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "bio": { "type": "object", "properties": { "manufacturer": { "type": "string", "example": "Dell" }, "ssn": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "model": { "type": "string", "example": "model description" }, "version": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "bios_date": { "type": "string", "example": "2020-01-01 00:00" } } }, "tag": { "type": "string", "example": "hardware tag" }, "asset_tag": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "hardware": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Hardware Name" }, "ip": { "type": "string", "example": "0.0.0.0" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Laptop" } } }, "owner": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "notes": { "type": "string", "example": "Hardware notes" }, "barcode_encoding_format": { "type": "string", "example": "Code1A" }, "cpu": { "type": "string", "example": "hardware_cpu" }, "processor_speed": { "type": "string", "example": "processor_speed" }, "memory": { "type": "string", "example": "1024" }, "swap": { "type": "string", "example": "MB" }, "domain": { "type": "string", "example": "domain description" }, "operating_system": { "type": "string", "example": "Windows 10" }, "active_directory": { "type": "string", "example": "Workgroup of the OS" }, "address": { "type": "string", "example": "Site 1, Building 1, Department 1" }, "longitude": { "type": "string", "example": "0.000" }, "latitude": { "type": "string", "example": "0.000" }, "product_number": { "type": "integer", "example": 1 }, "bio": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "manufacturer": { "type": "string", "example": "Dell" }, "ssn": { "type": "string", "example": "1" }, "model": { "type": "string", "example": "model description" }, "version": { "type": "string", "example": "1" }, "bios_date": { "type": "string", "example": "2020-01-01 00:00" }, "reported_at": { "type": "string", "example": "2020-01-01 00:00" } } } }, "tag": { "type": "string", "example": "hardware tag" }, "asset_tag": { "type": "string", "example": "1" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateHardwareById" }, "task": true }, { "name": "deleteHardwareById", "summary": "Delete hardware", "description": "Delete hardware", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteHardwareById" }, "task": true }, { "name": "getHardwares", "summary": "List of hardwares", "description": "List of hardwares", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of hardwares", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "hardware": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Hardware Name" }, "ip": { "type": "string", "example": "0.0.0.0" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Laptop" } } }, "owner": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "notes": { "type": "string", "example": "Hardware notes" }, "barcode_encoding_format": { "type": "string", "example": "Code1A" }, "cpu": { "type": "string", "example": "hardware_cpu" }, "processor_speed": { "type": "string", "example": "processor_speed" }, "memory": { "type": "string", "example": "1024" }, "swap": { "type": "string", "example": "MB" }, "domain": { "type": "string", "example": "domain description" }, "operating_system": { "type": "string", "example": "Windows 10" }, "active_directory": { "type": "string", "example": "Workgroup of the OS" }, "address": { "type": "string", "example": "Site 1, Building 1, Department 1" }, "longitude": { "type": "string", "example": "0.000" }, "latitude": { "type": "string", "example": "0.000" }, "product_number": { "type": "integer", "example": 1 }, "bio": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "manufacturer": { "type": "string", "example": "Dell" }, "ssn": { "type": "string", "example": "1" }, "model": { "type": "string", "example": "model description" }, "version": { "type": "string", "example": "1" }, "bios_date": { "type": "string", "example": "2020-01-01 00:00" }, "reported_at": { "type": "string", "example": "2020-01-01 00:00" } } } }, "tag": { "type": "string", "example": "hardware tag" }, "asset_tag": { "type": "string", "example": "1" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getHardwares" }, "task": true }, { "name": "createHardware", "summary": "Create new hardware", "description": "Create new hardware", "input": [ { "name": "body", "type": "object", "info": "Hardware fields to fill: {\"hardware\": {\"name\": \"string\", \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"category\": \"object\", \"ip_address\": \"string\", \"external_ip\": \"string\", \"status\": \"object\", \"technical_contact\": \"object\", \"owner\": \"object\", \"notes\": \"string\", \"barcode_encoding_format\": \"string\", \"cpu\": \"string\", \"memory\": \"undefined\", \"swap\": \"string\", \"domain\": \"string\", \"operating_system\": \"string\", \"active_directory\": \"string\", \"address\": \"string\", \"longitude\": \"string\", \"latitude\": \"string\", \"product_number\": \"undefined\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"bio\": {\"manufacturer\": \"string\", \"ssn\": \"undefined\", \"model\": \"string\", \"version\": \"undefined\", \"bios_date\": \"string\"}, \"tag\": \"string\", \"asset_tag\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "hardware": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Hardware Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "category": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "ip_address": { "type": "string", "example": "0.0.0.0" }, "external_ip": { "type": "string", "example": "0.0.0.0" }, "status": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "technical_contact": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "owner": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "notes": { "type": "string", "example": "Hardware notes" }, "barcode_encoding_format": { "type": "string", "example": "Code1A" }, "cpu": { "type": "string", "example": "hardware_cpu" }, "memory": { "anyOf": [ { "type": "string", "example": "1024" }, { "type": "integer", "example": 1024 } ] }, "swap": { "type": "string", "example": "MB" }, "domain": { "type": "string", "example": "domain description" }, "operating_system": { "type": "string", "example": "Windows 10" }, "active_directory": { "type": "string", "example": "Workgroup of the OS" }, "address": { "type": "string", "example": "Site 1, Building 1, Department 1" }, "longitude": { "type": "string", "example": "0.000" }, "latitude": { "type": "string", "example": "0.000" }, "product_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "bio": { "type": "object", "properties": { "manufacturer": { "type": "string", "example": "Dell" }, "ssn": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "model": { "type": "string", "example": "model description" }, "version": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "bios_date": { "type": "string", "example": "2020-01-01 00:00" } } }, "tag": { "type": "string", "example": "hardware tag" }, "asset_tag": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "hardware": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Hardware Name" }, "ip": { "type": "string", "example": "0.0.0.0" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "category": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Laptop" } } }, "owner": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "notes": { "type": "string", "example": "Hardware notes" }, "barcode_encoding_format": { "type": "string", "example": "Code1A" }, "cpu": { "type": "string", "example": "hardware_cpu" }, "processor_speed": { "type": "string", "example": "processor_speed" }, "memory": { "type": "string", "example": "1024" }, "swap": { "type": "string", "example": "MB" }, "domain": { "type": "string", "example": "domain description" }, "operating_system": { "type": "string", "example": "Windows 10" }, "active_directory": { "type": "string", "example": "Workgroup of the OS" }, "address": { "type": "string", "example": "Site 1, Building 1, Department 1" }, "longitude": { "type": "string", "example": "0.000" }, "latitude": { "type": "string", "example": "0.000" }, "product_number": { "type": "integer", "example": 1 }, "bio": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "manufacturer": { "type": "string", "example": "Dell" }, "ssn": { "type": "string", "example": "1" }, "model": { "type": "string", "example": "model description" }, "version": { "type": "string", "example": "1" }, "bios_date": { "type": "string", "example": "2020-01-01 00:00" }, "reported_at": { "type": "string", "example": "2020-01-01 00:00" } } } }, "tag": { "type": "string", "example": "hardware tag" }, "asset_tag": { "type": "string", "example": "1" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createHardware" }, "task": true }, { "name": "getWarranties", "summary": "List of warranties", "description": "List of warranties", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of warranties", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "warranty": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "service": { "type": "string", "example": "Warranty service description" }, "provider": { "type": "string", "example": "SolarWinds" }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "status": { "type": "string", "example": "Active" }, "manual": { "type": "boolean", "example": false } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getWarranties" }, "task": true }, { "name": "createWarranty", "summary": "Create new Warranty", "description": "Create new Warranty", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Warranty fields to fill: {\"warranty\": {\"service\": \"string\", \"provider\": \"string\", \"start_date\": \"string\", \"end_date\": \"string\", \"status\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "warranty": { "type": "object", "properties": { "service": { "type": "string", "example": "Warranty service description" }, "provider": { "type": "string", "example": "SolarWinds" }, "start_date": { "type": "string", "example": "Jan 01, 2020" }, "end_date": { "type": "string", "example": "Jan 01, 2030" }, "status": { "type": "string", "example": "Active" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "warranty": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "service": { "type": "string", "example": "Warranty service description" }, "provider": { "type": "string", "example": "SolarWinds" }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "status": { "type": "string", "example": "Active" }, "manual": { "type": "boolean", "example": false } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createWarranty" }, "task": true }, { "name": "updateWarrantyById", "summary": "Update warranty with specified fields", "description": "Update warranty with specified fields", "input": [ { "name": "hardwareId", "type": "string", "info": "Numeric ID of the hardware: string", "required": true, "schema": { "title": "hardwareId", "type": "string" } }, { "name": "warrantyId", "type": "string", "info": "Numeric ID of the warranty: string", "required": true, "schema": { "title": "warrantyId", "type": "string" } }, { "name": "body", "type": "object", "info": "Warranty fields to update: {\"warranty\": {\"service\": \"string\", \"provider\": \"string\", \"start_date\": \"string\", \"end_date\": \"string\", \"status\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "warranty": { "type": "object", "properties": { "service": { "type": "string", "example": "Warranty service description" }, "provider": { "type": "string", "example": "SolarWinds" }, "start_date": { "type": "string", "example": "Jan 01, 2020" }, "end_date": { "type": "string", "example": "Jan 01, 2030" }, "status": { "type": "string", "example": "Active" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "warranty": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "service": { "type": "string", "example": "Warranty service description" }, "provider": { "type": "string", "example": "SolarWinds" }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "status": { "type": "string", "example": "Active" }, "manual": { "type": "boolean", "example": false } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateWarrantyById" }, "task": true }, { "name": "deleteWarrantyById", "summary": "Delete warranty", "description": "Delete warranty", "input": [ { "name": "hardwareId", "type": "string", "info": "Numeric ID of the hardware: string", "required": true, "schema": { "title": "hardwareId", "type": "string" } }, { "name": "warrantyId", "type": "string", "info": "Numeric ID of the warranty: string", "required": true, "schema": { "title": "warrantyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteWarrantyById" }, "task": true }, { "name": "getMobileById", "summary": "Get mobile device", "description": "Get mobile device", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "mobile": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Apple 1" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "device_type": { "type": "string", "example": "Mobile Device" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "type": "string", "example": "1" }, "company_issued": { "type": "boolean", "example": true }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "imei": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getMobileById" }, "task": true }, { "name": "updateMobileById", "summary": "Update mobile device with specified fields", "description": "Update mobile device with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Mobile device fields to update: {\"mobile\": {\"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"status\": \"object\", \"device_type\": \"string\", \"manufacturer\": \"string\", \"model\": \"undefined\", \"company_issued\": \"boolean\", \"serial_number\": \"undefined\", \"imei\": \"undefined\", \"user\": \"object\", \"technical_contact\": \"object\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "mobile": { "type": "object", "properties": { "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "status": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "device_type": { "type": "string", "example": "Mobile Device" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "company_issued": { "type": "boolean", "example": true }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "imei": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "technical_contact": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "mobile": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Apple 1" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "device_type": { "type": "string", "example": "Mobile Device" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "type": "string", "example": "1" }, "company_issued": { "type": "boolean", "example": true }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "imei": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateMobileById" }, "task": true }, { "name": "deleteMobileById", "summary": "Delete mobile device", "description": "Delete mobile device", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMobileById" }, "task": true }, { "name": "getMobiles", "summary": "List of mobile devices", "description": "List of mobile devices", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of mobile devices", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "mobile": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Apple 1" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "device_type": { "type": "string", "example": "Mobile Device" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "type": "string", "example": "1" }, "company_issued": { "type": "boolean", "example": true }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "imei": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getMobiles" }, "task": true }, { "name": "createMobile", "summary": "Create new mobile device", "description": "Create new mobile device", "input": [ { "name": "body", "type": "object", "info": "Mobile Device fields to fill: {\"mobile\": {\"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"status\": \"object\", \"device_type\": \"string\", \"manufacturer\": \"string\", \"model\": \"undefined\", \"company_issued\": \"boolean\", \"serial_number\": \"undefined\", \"imei\": \"undefined\", \"user\": \"object\", \"technical_contact\": \"object\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "mobile": { "type": "object", "required": [ "model", "manufacturer", "serial_number" ], "properties": { "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "status": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "device_type": { "type": "string", "example": "Mobile Device" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "company_issued": { "type": "boolean", "example": true }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "imei": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "technical_contact": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "mobile": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Apple 1" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "device_type": { "type": "string", "example": "Mobile Device" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "type": "string", "example": "1" }, "company_issued": { "type": "boolean", "example": true }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "imei": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMobile" }, "task": true }, { "name": "getAssetById", "summary": "Get other asset", "description": "Get other asset", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "other_asset": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Apple 1" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "asset_type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Asset Type" } } }, "asset_id": { "type": "string", "example": "1" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "type": "string", "example": "1" }, "ip": { "type": "string", "example": "0.0.0.0" }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "owner": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAssetById" }, "task": true }, { "name": "updateAssetById", "summary": "Update other asset with specified fields", "description": "Update other asset with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Other asset fields to update: {\"other_asset\": {\"name\": \"string\", \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"asset_id\": \"undefined\", \"asset_type\": \"object\", \"status\": \"object\", \"manufacturer\": \"string\", \"ip_address\": \"string\", \"model\": \"undefined\", \"serial_number\": \"undefined\", \"user\": \"object\", \"owner\": \"object\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "other_asset": { "type": "object", "properties": { "name": { "type": "string", "example": "Asset Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "asset_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "asset_type": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ], "example": { "name": "Printer" } }, "status": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ], "example": { "name": "Operational" } }, "manufacturer": { "type": "string", "example": "Apple" }, "ip_address": { "type": "string", "example": "0.0.0.0" }, "model": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "owner": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "other_asset": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Apple 1" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "asset_type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Asset Type" } } }, "asset_id": { "type": "string", "example": "1" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "type": "string", "example": "1" }, "ip": { "type": "string", "example": "0.0.0.0" }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "owner": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateAssetById" }, "task": true }, { "name": "deleteAssetById", "summary": "Delete other asset", "description": "Delete other asset", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAssetById" }, "task": true }, { "name": "getAssets", "summary": "List of other assets", "description": "List of other assets", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of other assets", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "other_asset": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Apple 1" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "asset_type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Asset Type" } } }, "asset_id": { "type": "string", "example": "1" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "type": "string", "example": "1" }, "ip": { "type": "string", "example": "0.0.0.0" }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "owner": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getAssets" }, "task": true }, { "name": "createAsset", "summary": "Create new asset", "description": "Create new asset", "input": [ { "name": "body", "type": "object", "info": "Other Asset fields to fill: {\"other_asset\": {\"name\": \"string\", \"description\": \"string\", \"site\": \"object\", \"department\": \"object\", \"site_id\": \"undefined\", \"department_id\": \"undefined\", \"asset_id\": \"undefined\", \"asset_type\": \"object\", \"status\": \"object\", \"manufacturer\": \"string\", \"ip_address\": \"string\", \"model\": \"undefined\", \"serial_number\": \"undefined\", \"user\": \"object\", \"owner\": \"object\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "other_asset": { "type": "object", "required": [ "name", "manufacturer", "asset_type" ], "properties": { "name": { "type": "string", "example": "Asset Name" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "asset_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "asset_type": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ], "example": { "name": "Printer" } }, "status": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ], "example": { "name": "Operational" } }, "manufacturer": { "type": "string", "example": "Apple" }, "ip_address": { "type": "string", "example": "0.0.0.0" }, "model": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "owner": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "other_asset": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Apple 1" }, "description": { "type": "string", "example": "description" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "status": { "type": "string", "example": "Operational" }, "asset_type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "parent_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Asset Type" } } }, "asset_id": { "type": "string", "example": "1" }, "manufacturer": { "type": "string", "example": "Apple" }, "model": { "type": "string", "example": "1" }, "ip": { "type": "string", "example": "0.0.0.0" }, "serial_number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "owner": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createAsset" }, "task": true }, { "name": "getSoftwareById", "summary": "Get software", "description": "Get software", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "software": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Google Chrome" }, "tag": { "type": "string", "example": "software tag" }, "manufacturer": { "type": "string", "example": "Google LLC" }, "version": { "type": "string", "example": "0.0.0" }, "category": { "type": "string", "example": "Google softwares" }, "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Google" }, "address": { "type": "string", "example": "address description" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "Texas" }, "zip": { "type": "string", "example": "1" }, "tech_support": { "type": "string", "example": "+000000000", "description": "support phone number" }, "business_phone": { "type": "string", "example": "+000000000", "description": "business phone" }, "url": { "type": "string", "example": "www.google.com" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" } } }, "installs": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSoftwareById" }, "task": true }, { "name": "getSoftwares", "summary": "List of softwares", "description": "List of softwares", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of softwares", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "software": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Google Chrome" }, "tag": { "type": "string", "example": "software tag" }, "manufacturer": { "type": "string", "example": "Google LLC" }, "version": { "type": "string", "example": "0.0.0" }, "category": { "type": "string", "example": "Google softwares" }, "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Google" }, "address": { "type": "string", "example": "address description" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "Texas" }, "zip": { "type": "string", "example": "1" }, "tech_support": { "type": "string", "example": "+000000000", "description": "support phone number" }, "business_phone": { "type": "string", "example": "+000000000", "description": "business phone" }, "url": { "type": "string", "example": "www.google.com" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" } } }, "installs": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getSoftwares" }, "task": true }, { "name": "getPrinterById", "summary": "Get printer", "description": "Get printer", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "printer": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "HP Color Printer" }, "driver": { "type": "string", "example": "Driver description" }, "port": { "type": "string", "example": "Port description" }, "shared": { "type": "boolean", "example": true }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPrinterById" }, "task": true }, { "name": "updatePrinterById", "summary": "Update printer with specified fields", "description": "Update printer with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Printer fields to update: {\"printer\": {\"site_id\": \"undefined\", \"department_id\": \"undefined\", \"technical_contact\": \"object\", \"address\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "printer": { "type": "object", "properties": { "site_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "department_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "technical_contact": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "address": { "type": "string", "example": "address description", "description": "Building/Floor/Room" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "printer": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "HP Color Printer" }, "driver": { "type": "string", "example": "Driver description" }, "port": { "type": "string", "example": "Port description" }, "shared": { "type": "boolean", "example": true }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatePrinterById" }, "task": true }, { "name": "getPrinters", "summary": "List of printers", "description": "List of printers", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of printers", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "printer": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "HP Color Printer" }, "driver": { "type": "string", "example": "Driver description" }, "port": { "type": "string", "example": "Port description" }, "shared": { "type": "boolean", "example": true }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "technical_contact": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getPrinters" }, "task": true }, { "name": "getContractById", "summary": "Get contract", "description": "Get contract", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "contract": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Contract Name" }, "type": { "type": "string", "example": "Software License" }, "manufacturer_name": { "type": "string", "example": "Apple" }, "note": { "type": "string", "example": "Contract Note" }, "status": { "type": "string", "example": "Active" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00-00:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00-00:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "0.0.0" }, "quantity": { "type": "string", "example": "1" }, "notes": { "type": "string", "example": "Item notes" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }, "tag": { "type": "string", "example": "example tag" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getContractById" }, "task": true }, { "name": "updateContractById", "summary": "Update contract with specified fields", "description": "Update contract with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Contract fields to update: {\"contract\": {\"type\": \"string\", \"manufacturer_name\": \"string\", \"name\": \"string\", \"note\": \"string\", \"status\": \"string\", \"site\": \"object\", \"department\": \"object\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"start_date\": \"string\", \"end_date\": \"string\", \"tag_list\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "contract": { "type": "object", "properties": { "type": { "type": "string", "example": "Software License" }, "manufacturer_name": { "type": "string", "example": "Apple" }, "name": { "type": "string", "example": "Contract Name" }, "note": { "type": "string", "example": "Contract Note" }, "status": { "type": "string", "example": "Active" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00-00:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00-00:00" }, "tag_list": { "type": "string", "example": "tag1, tag2" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "contract": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Contract Name" }, "type": { "type": "string", "example": "Software License" }, "manufacturer_name": { "type": "string", "example": "Apple" }, "note": { "type": "string", "example": "Contract Note" }, "status": { "type": "string", "example": "Active" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00-00:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00-00:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "0.0.0" }, "quantity": { "type": "string", "example": "1" }, "notes": { "type": "string", "example": "Item notes" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }, "tag": { "type": "string", "example": "example tag" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateContractById" }, "task": true }, { "name": "deleteContractById", "summary": "Delete contract", "description": "Delete contract", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteContractById" }, "task": true }, { "name": "getContracts", "summary": "List of contracts", "description": "List of contracts", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of contracts", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "contract": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Contract Name" }, "type": { "type": "string", "example": "Software License" }, "manufacturer_name": { "type": "string", "example": "Apple" }, "note": { "type": "string", "example": "Contract Note" }, "status": { "type": "string", "example": "Active" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00-00:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00-00:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "0.0.0" }, "quantity": { "type": "string", "example": "1" }, "notes": { "type": "string", "example": "Item notes" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }, "tag": { "type": "string", "example": "example tag" } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getContracts" }, "task": true }, { "name": "createContract", "summary": "Create new contract", "description": "Create new contract", "input": [ { "name": "body", "type": "object", "info": "Contract fields to fill: {\"contract\": {\"type\": \"string\", \"manufacturer_name\": \"string\", \"name\": \"string\", \"note\": \"string\", \"status\": \"string\", \"site\": \"object\", \"department\": \"object\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"start_date\": \"string\", \"end_date\": \"string\", \"tag_list\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "contract": { "type": "object", "required": [ "name", "manufacturer_name" ], "properties": { "type": { "type": "string", "example": "Software License" }, "manufacturer_name": { "type": "string", "example": "Apple" }, "name": { "type": "string", "example": "Contract Name" }, "note": { "type": "string", "example": "Contract Note" }, "status": { "type": "string", "example": "Active" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00-00:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00-00:00" }, "tag_list": { "type": "string", "example": "tag1, tag2" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "contract": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Contract Name" }, "type": { "type": "string", "example": "Software License" }, "manufacturer_name": { "type": "string", "example": "Apple" }, "note": { "type": "string", "example": "Contract Note" }, "status": { "type": "string", "example": "Active" }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "start_date": { "type": "string", "example": "2020-01-01T00:00:00-00:00" }, "end_date": { "type": "string", "example": "2030-01-01T00:00:00-00:00" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "tag name" }, "taggings_count": { "type": "integer", "example": 1 } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "0.0.0" }, "quantity": { "type": "string", "example": "1" }, "notes": { "type": "string", "example": "Item notes" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }, "tag": { "type": "string", "example": "example tag" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createContract" }, "task": true }, { "name": "createItem", "summary": "Create new contract's Item", "description": "Create new contract's Item", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Item fields to fill: {\"item\": {\"name\": \"string\", \"version\": \"undefined\", \"qty\": \"undefined\", \"tag\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "item": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "qty": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "tag": { "type": "string", "example": "Item tag" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "1" }, "qty": { "type": "string", "example": "1" }, "tag": { "type": "string", "example": "Item tag" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createItem" }, "task": true }, { "name": "updateItemById", "summary": "Update contract's item with specified fields", "description": "Update contract's item with specified fields", "input": [ { "name": "contractId", "type": "string", "info": "Numeric ID of the contract: string", "required": true, "schema": { "title": "contractId", "type": "string" } }, { "name": "itemId", "type": "string", "info": "Numeric ID of the item: string", "required": true, "schema": { "title": "itemId", "type": "string" } }, { "name": "body", "type": "object", "info": "Contract's Item fields to update: {\"item\": {\"name\": \"string\", \"version\": \"undefined\", \"qty\": \"undefined\", \"tag\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "item": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "qty": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "tag": { "type": "string", "example": "Item tag" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "item": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "1" }, "qty": { "type": "string", "example": "1" }, "tag": { "type": "string", "example": "Item tag" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateItemById" }, "task": true }, { "name": "deleteitemById", "summary": "Delete contract's item", "description": "Delete contract's item", "input": [ { "name": "contractId", "type": "string", "info": "Numeric ID of the contract: string", "required": true, "schema": { "title": "contractId", "type": "string" } }, { "name": "itemId", "type": "string", "info": "Numeric ID of the item: string", "required": true, "schema": { "title": "itemId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteitemById" }, "task": true }, { "name": "getPurchaseOrderById", "summary": "Get purchase order", "description": "Get purchase order", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "purchase_order": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Purchase order Name" }, "order_date": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "due_date": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "buyer": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "state": { "type": "string", "example": "Approved" }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } }, "example": { "id": "1", "name": "John Doe", "href": "/users/1" } }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "type": "string", "example": "1" }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "billing_address": { "type": "string", "example": "Billing address" }, "shiping_address": { "type": "string", "example": "Shiping address" }, "payment_terms": { "type": "string", "example": "Purchase terms" }, "terms_conditions": { "type": "string", "example": "Terms conditions" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "0.0.0" }, "quantity": { "type": "string", "example": "1" }, "notes": { "type": "string", "example": "Item notes" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }, "tag": { "type": "string", "example": "example tag" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPurchaseOrderById" }, "task": true }, { "name": "updatePurchaseOrderById", "summary": "Update purchase order with specified fields", "description": "Update purchase order with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Purchase Order fields to update: {\"purchase_order\": {\"name\": \"string\", \"buyer_id\": \"undefined\", \"order_date\": \"string\", \"due_date\": \"string\", \"site\": \"object\", \"department\": \"object\", \"state\": \"string\", \"requester\": \"object\", \"recurrence\": \"string\", \"total_cost\": \"undefined\", \"currency\": \"string\", \"notes\": \"string\", \"vendor\": \"object\", \"billing_address\": \"string\", \"shiping_address\": \"string\", \"payment_terms\": \"string\", \"terms_conditions\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"approval_levels_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "purchase_order": { "type": "object", "properties": { "name": { "type": "string", "example": "Purchase order Name" }, "buyer_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "order_date": { "type": "string", "example": "Jan 01, 2025" }, "due_date": { "type": "string", "example": "Jan 01, 2030" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "state": { "type": "string", "example": "Approved" }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "billing_address": { "type": "string", "example": "Billing address" }, "shiping_address": { "type": "string", "example": "Shiping address" }, "payment_terms": { "type": "string", "example": "Purchase terms" }, "terms_conditions": { "type": "string", "example": "Terms conditions" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "approval_levels_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "approver_ids": { "type": "string", "example": "1, 2" }, "approval_condition": { "type": "string", "example": "1" } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "approver_ids": { "type": "string", "example": "1, 2" }, "approval_condition": { "type": "string", "example": "1" } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "purchase_order": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Purchase order Name" }, "order_date": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "due_date": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "buyer": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "state": { "type": "string", "example": "Approved" }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } }, "example": { "id": "1", "name": "John Doe", "href": "/users/1" } }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "type": "string", "example": "1" }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "billing_address": { "type": "string", "example": "Billing address" }, "shiping_address": { "type": "string", "example": "Shiping address" }, "payment_terms": { "type": "string", "example": "Purchase terms" }, "terms_conditions": { "type": "string", "example": "Terms conditions" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "0.0.0" }, "quantity": { "type": "string", "example": "1" }, "notes": { "type": "string", "example": "Item notes" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }, "tag": { "type": "string", "example": "example tag" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatePurchaseOrderById" }, "task": true }, { "name": "deletePurchaseOrderById", "summary": "Delete purchase order", "description": "Delete purchase order", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePurchaseOrderById" }, "task": true }, { "name": "getCPurchaseOrders", "summary": "List of purchase orders", "description": "List of purchase orders", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of purchase orders", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "purchase_order": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Purchase order Name" }, "order_date": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "due_date": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "buyer": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "state": { "type": "string", "example": "Approved" }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } }, "example": { "id": "1", "name": "John Doe", "href": "/users/1" } }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "type": "string", "example": "1" }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "billing_address": { "type": "string", "example": "Billing address" }, "shiping_address": { "type": "string", "example": "Shiping address" }, "payment_terms": { "type": "string", "example": "Purchase terms" }, "terms_conditions": { "type": "string", "example": "Terms conditions" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "0.0.0" }, "quantity": { "type": "string", "example": "1" }, "notes": { "type": "string", "example": "Item notes" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }, "tag": { "type": "string", "example": "example tag" } } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getCPurchaseOrders" }, "task": true }, { "name": "createPurchaseOrder", "summary": "Create new purchase order", "description": "Create new purchase order", "input": [ { "name": "body", "type": "object", "info": "Purchase order fields to fill: {\"purchase_order\": {\"name\": \"string\", \"buyer_id\": \"undefined\", \"order_date\": \"string\", \"due_date\": \"string\", \"site\": \"object\", \"department\": \"object\", \"state\": \"string\", \"requester\": \"object\", \"recurrence\": \"string\", \"total_cost\": \"undefined\", \"currency\": \"string\", \"notes\": \"string\", \"vendor\": \"object\", \"billing_address\": \"string\", \"shiping_address\": \"string\", \"payment_terms\": \"string\", \"terms_conditions\": \"string\", \"custom_fields_values\": {\"custom_fields_value\": \"undefined\"}, \"custom_fields_values_attributes\": \"undefined\", \"approval_levels_attributes\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "purchase_order": { "type": "object", "required": [ "name", "vendor" ], "properties": { "name": { "type": "string", "example": "Purchase order Name" }, "buyer_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "order_date": { "type": "string", "example": "Jan 01, 2025" }, "due_date": { "type": "string", "example": "Jan 01, 2030" }, "site": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "department": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "state": { "type": "string", "example": "Approved" }, "requester": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] }, "billing_address": { "type": "string", "example": "Billing address" }, "shiping_address": { "type": "string", "example": "Shiping address" }, "payment_terms": { "type": "string", "example": "Purchase terms" }, "terms_conditions": { "type": "string", "example": "Terms conditions" }, "custom_fields_values": { "type": "object", "required": [ "custom_fields_value" ], "properties": { "custom_fields_value": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Name of custom text field" }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] }, "user_value": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] } } } ] } } }, "custom_fields_values_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "value": { "anyOf": [ { "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" }, { "content": { "application/octet-stream": {} }, "description": "attachment custom field" } ] } } } } ] }, "approval_levels_attributes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "approver_ids": { "type": "string", "example": "1, 2" }, "approval_condition": { "type": "string", "example": "1" } } } }, { "type": "object", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "approver_ids": { "type": "string", "example": "1, 2" }, "approval_condition": { "type": "string", "example": "1" } } } } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "purchase_order": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Purchase order Name" }, "order_date": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "due_date": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "buyer": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "state": { "type": "string", "example": "Approved" }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } }, "example": { "id": "1", "name": "John Doe", "href": "/users/1" } }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "type": "string", "example": "1" }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Object Name" }, "href": { "type": "string", "example": "/objects/1" } } }, "billing_address": { "type": "string", "example": "Billing address" }, "shiping_address": { "type": "string", "example": "Shiping address" }, "payment_terms": { "type": "string", "example": "Purchase terms" }, "terms_conditions": { "type": "string", "example": "Terms conditions" }, "custom_fields_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "custom_field_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": " Name of custom text field" }, "value": { "type": "string", "example": "content" }, "type_name": { "type": "string", "example": "Text" } } } }, "purchase_order_items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Item Name" }, "version": { "type": "string", "example": "0.0.0" }, "quantity": { "type": "string", "example": "1" }, "notes": { "type": "string", "example": "Item notes" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }, "tag": { "type": "string", "example": "example tag" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPurchaseOrder" }, "task": true }, { "name": "getVendorById", "summary": "Get vendor", "description": "Get vendor", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "SolarWinds" }, "vendor_type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "General Business Vendor" } } }, "url": { "type": "string", "example": "www.solarwinds.com" }, "contact_name": { "type": "string", "example": "Support" }, "contact_email": { "type": "string", "example": "support@solarwinds.com" }, "contact_phone": { "type": "string", "example": "+000000000" }, "note": { "type": "string", "example": "Notes" }, "address": { "type": "string", "example": "Address description" }, "city": { "type": "string", "example": "Cary" }, "state": { "type": "string", "example": "NC" }, "zip": { "type": "string", "example": "USA 11111" }, "telephone": { "type": "string", "example": "+000000000" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getVendorById" }, "task": true }, { "name": "updateVendorById", "summary": "Update vendor with specified fields", "description": "Update vendor with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "Vendor fields to update: {\"vendor\": {\"name\": \"string\", \"vendor_type\": \"object\", \"url\": \"string\", \"contact_name\": \"string\", \"contact_email\": \"string\", \"contact_phone\": \"string\", \"note\": \"string\", \"address\": \"string\", \"city\": \"string\", \"state\": \"string\", \"zip\": \"string\", \"telephone\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "vendor": { "type": "object", "properties": { "name": { "type": "string", "example": "SolarWinds" }, "vendor_type": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ], "example": { "name": "General Business Vendor" } }, "url": { "type": "string", "example": "www.solarwinds.com" }, "contact_name": { "type": "string", "example": "Support" }, "contact_email": { "type": "string", "example": "support@solarwinds.com" }, "contact_phone": { "type": "string", "example": "+000000000" }, "note": { "type": "string", "example": "Notes" }, "address": { "type": "string", "example": "Address description" }, "city": { "type": "string", "example": "Cary" }, "state": { "type": "string", "example": "NC" }, "zip": { "type": "string", "example": "USA 11111" }, "telephone": { "type": "string", "example": "+000000000" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "SolarWinds" }, "vendor_type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "General Business Vendor" } } }, "url": { "type": "string", "example": "www.solarwinds.com" }, "contact_name": { "type": "string", "example": "Support" }, "contact_email": { "type": "string", "example": "support@solarwinds.com" }, "contact_phone": { "type": "string", "example": "+000000000" }, "note": { "type": "string", "example": "Notes" }, "address": { "type": "string", "example": "Address description" }, "city": { "type": "string", "example": "Cary" }, "state": { "type": "string", "example": "NC" }, "zip": { "type": "string", "example": "USA 11111" }, "telephone": { "type": "string", "example": "+000000000" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateVendorById" }, "task": true }, { "name": "deleteVendorById", "summary": "Delete vendor", "description": "Delete vendor", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVendorById" }, "task": true }, { "name": "getVendors", "summary": "List of vendors", "description": "List of vendors", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of vendors", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "SolarWinds" }, "vendor_type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "General Business Vendor" } } }, "url": { "type": "string", "example": "www.solarwinds.com" }, "contact_name": { "type": "string", "example": "Support" }, "contact_email": { "type": "string", "example": "support@solarwinds.com" }, "contact_phone": { "type": "string", "example": "+000000000" }, "note": { "type": "string", "example": "Notes" }, "address": { "type": "string", "example": "Address description" }, "city": { "type": "string", "example": "Cary" }, "state": { "type": "string", "example": "NC" }, "zip": { "type": "string", "example": "USA 11111" }, "telephone": { "type": "string", "example": "+000000000" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getVendors" }, "task": true }, { "name": "createVendor", "summary": "Create new vendor", "description": "Create new vendor", "input": [ { "name": "body", "type": "object", "info": "Vendor fields to fill: {\"vendor\": {\"name\": \"string\", \"vendor_type\": \"object\", \"url\": \"string\", \"contact_name\": \"string\", \"contact_email\": \"string\", \"contact_phone\": \"string\", \"note\": \"string\", \"address\": \"string\", \"city\": \"string\", \"state\": \"string\", \"zip\": \"string\", \"telephone\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "vendor": { "type": "object", "required": [ "name", "vendor_type" ], "properties": { "name": { "type": "string", "example": "SolarWinds" }, "vendor_type": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ], "example": { "name": "General Business Vendor" } }, "url": { "type": "string", "example": "www.solarwinds.com" }, "contact_name": { "type": "string", "example": "Support" }, "contact_email": { "type": "string", "example": "support@solarwinds.com" }, "contact_phone": { "type": "string", "example": "+000000000" }, "note": { "type": "string", "example": "Notes" }, "address": { "type": "string", "example": "Address description" }, "city": { "type": "string", "example": "Cary" }, "state": { "type": "string", "example": "NC" }, "zip": { "type": "string", "example": "USA 11111" }, "telephone": { "type": "string", "example": "+000000000" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "SolarWinds" }, "vendor_type": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "General Business Vendor" } } }, "url": { "type": "string", "example": "www.solarwinds.com" }, "contact_name": { "type": "string", "example": "Support" }, "contact_email": { "type": "string", "example": "support@solarwinds.com" }, "contact_phone": { "type": "string", "example": "+000000000" }, "note": { "type": "string", "example": "Notes" }, "address": { "type": "string", "example": "Address description" }, "city": { "type": "string", "example": "Cary" }, "state": { "type": "string", "example": "NC" }, "zip": { "type": "string", "example": "USA 11111" }, "telephone": { "type": "string", "example": "+000000000" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVendor" }, "task": true }, { "name": "createTask", "summary": "Create new Task", "description": "Create new Task", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "body", "type": "object", "info": "Task fields to fill: {\"task\": {\"name\": \"string\", \"assignee\": \"object\", \"due_at\": \"string\", \"is_complete\": \"boolean\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "task": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Task Name" }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "due_at": { "type": "string", "example": "Jan 01, 2030" }, "is_complete": { "type": "boolean", "example": false } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "task": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Task Name" }, "due_at": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "parent": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "class": { "type": "string", "example": "Incident" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTask" }, "task": true }, { "name": "updateTaskById", "summary": "Update task with specified fields", "description": "Update task with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "taskId", "type": "string", "info": "Numeric ID of the task: string", "required": true, "schema": { "title": "taskId", "type": "string" } }, { "name": "body", "type": "object", "info": "Task fields to update: {\"task\": {\"name\": \"string\", \"assignee\": \"object\", \"due_at\": \"string\", \"is_complete\": \"boolean\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "task": { "type": "object", "properties": { "name": { "type": "string", "example": "Task Name" }, "assignee": { "type": "object", "oneOf": [ { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "john.doe@email.com" } } }, { "enum": [ "nil", "" ] } ] }, "due_at": { "type": "string", "example": "Jan 01, 2030" }, "is_complete": { "type": "boolean", "example": false } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "task": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Task Name" }, "due_at": { "type": "string", "example": "2030-01-01T00:00:00.000+01:00" }, "requester": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "assignee": { "type": "object", "properties": { "group_id": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "is_user": { "oneOf": [ { "type": "string", "example": "true" }, { "type": "boolean" } ] }, "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "example": "john.doe@email.com" }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "parent": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "class": { "type": "string", "example": "Incident" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateTaskById" }, "task": true }, { "name": "deleteTaskById", "summary": "Delete task", "description": "Delete task", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "taskId", "type": "string", "info": "Numeric ID of the task: string", "required": true, "schema": { "title": "taskId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTaskById" }, "task": true }, { "name": "createComment", "summary": "Create new Comment", "description": "Create new Comment", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "body", "type": "object", "info": "Comment fields to fill: {\"comment\": {\"body\": \"string\", \"is_private\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "comment": { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "example": "Comment body" }, "is_private": { "anyOf": [ { "type": "string", "example": "true" }, { "type": "boolean", "example": true } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "comment": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "body": { "type": "string", "example": "Comment body" }, "is_private": { "type": "string", "example": "true" }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "commenter_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "commenter_type": { "type": "string", "example": "Incident" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createComment" }, "task": true }, { "name": "updateCommentById", "summary": "Update comment with specified fields", "description": "Update comment with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "commentId", "type": "string", "info": "Numeric ID of the comment: string", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "body", "type": "object", "info": "Comment fields to update: {\"comment\": {\"body\": \"string\", \"is_private\": \"undefined\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "comment": { "type": "object", "properties": { "body": { "type": "string", "example": "Comment body" }, "is_private": { "anyOf": [ { "type": "string", "example": "true" }, { "type": "boolean", "example": true } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "comment": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "body": { "type": "string", "example": "Comment body" }, "is_private": { "type": "string", "example": "true" }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "commenter_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "commenter_type": { "type": "string", "example": "Incident" } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateCommentById" }, "task": true }, { "name": "deleteCommentById", "summary": "Delete comment", "description": "Delete comment", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "commentId", "type": "string", "info": "Numeric ID of the comment: string", "required": true, "schema": { "title": "commentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteCommentById" }, "task": true }, { "name": "getTimeTracks", "summary": "List of time tracks", "description": "List of time tracks", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of time tracks", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "time_track": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Time Track Name" }, "minutes": { "type": "string", "example": "120" }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "creator": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "parent": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "class": { "type": "string", "example": "Incident" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTimeTracks" }, "task": true }, { "name": "createTimeTrack", "summary": "Create new time track", "description": "Create new time track", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "body", "type": "object", "info": "Time track fields to fill: {\"time_track\": {\"name\": \"string\", \"minutes_parsed\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "time_track": { "type": "object", "properties": { "name": { "type": "string", "example": "Time Track Name" }, "minutes_parsed": { "type": "string", "example": "2h" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "time_track": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Time Track Name" }, "minutes": { "type": "string", "example": "120" }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "creator": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "parent": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "class": { "type": "string", "example": "Incident" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTimeTrack" }, "task": true }, { "name": "updateTimeTrackyById", "summary": "Update time track with specified fields", "description": "Update time track with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "timeTrackId", "type": "string", "info": "Numeric ID of the time track: string", "required": true, "schema": { "title": "timeTrackId", "type": "string" } }, { "name": "body", "type": "object", "info": "Time track fields to update: {\"time_track\": {\"name\": \"string\", \"minutes_parsed\": \"string\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "time_track": { "type": "object", "properties": { "name": { "type": "string", "example": "Time Track Name" }, "minutes_parsed": { "type": "string", "example": "2h" } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "time_track": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Time Track Name" }, "minutes": { "type": "string", "example": "120" }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "creator": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "parent": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "class": { "type": "string", "example": "Incident" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateTimeTrackyById" }, "task": true }, { "name": "deleteTimeTrackyById", "summary": "Delete time track", "description": "Delete time track", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "timeTrackId", "type": "string", "info": "Numeric ID of the time track: string", "required": true, "schema": { "title": "timeTrackId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTimeTrackyById" }, "task": true }, { "name": "createPurchase", "summary": "Create new purchase", "description": "Create new purchase", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "body", "type": "object", "info": "Purchase fields to fill: {\"purchase\": {\"number\": \"undefined\", \"date\": \"string\", \"recurrence\": \"string\", \"total_cost\": \"undefined\", \"currency\": \"string\", \"notes\": \"string\", \"vendor\": \"object\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "purchase": { "type": "object", "required": [ "name" ], "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "date": { "type": "string", "example": "Jan 01, 2025" }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "purchase": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "number": { "type": "string", "example": "1" }, "date": { "type": "string", "example": "Jan 01, 2025" }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "type": "string", "example": "1" }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Google" }, "address": { "type": "string", "example": "address description" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "Texas" }, "zip": { "type": "string", "example": "1" }, "tech_support": { "type": "string", "example": "+000000000", "description": "support phone number" }, "business_phone": { "type": "string", "example": "+000000000", "description": "business phone" }, "url": { "type": "string", "example": "www.google.com" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPurchase" }, "task": true }, { "name": "updatePurchaseById", "summary": "Update purchase with specified fields", "description": "Update purchase with specified fields", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "purchaseId", "type": "string", "info": "Numeric ID of the purchase: string", "required": true, "schema": { "title": "purchaseId", "type": "string" } }, { "name": "body", "type": "object", "info": "Purchase fields to update: {\"purchase\": {\"number\": \"undefined\", \"date\": \"string\", \"recurrence\": \"string\", \"total_cost\": \"undefined\", \"currency\": \"string\", \"notes\": \"string\", \"vendor\": \"object\"}}", "required": true, "schema": { "type": "object", "xml": { "name": "/" }, "properties": { "purchase": { "type": "object", "properties": { "number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "date": { "type": "string", "example": "Jan 01, 2025" }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "example": "Object Name" } } }, { "enum": [ "nil", "" ] } ] } } } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "purchase": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "number": { "type": "string", "example": "1" }, "date": { "type": "string", "example": "Jan 01, 2025" }, "recurrence": { "type": "string", "example": "Monthly" }, "total_cost": { "type": "string", "example": "1" }, "currency": { "type": "string", "example": "USD" }, "notes": { "type": "string", "example": "Purchase notes" }, "vendor": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Google" }, "address": { "type": "string", "example": "address description" }, "country": { "type": "string", "example": "US" }, "city": { "type": "string", "example": "Texas" }, "zip": { "type": "string", "example": "1" }, "tech_support": { "type": "string", "example": "+000000000", "description": "support phone number" }, "business_phone": { "type": "string", "example": "+000000000", "description": "business phone" }, "url": { "type": "string", "example": "www.google.com" }, "created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" }, "updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatePurchaseById" }, "task": true }, { "name": "deletePurchaseById", "summary": "Delete purchase", "description": "Delete purchase", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } }, { "name": "purchaseId", "type": "string", "info": "Numeric ID of the purchase: string", "required": true, "schema": { "title": "purchaseId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePurchaseById" }, "task": true }, { "name": "createMembership", "summary": "Create new Membership. Memberships are used to relate a user to a group.\nExample: curl -H \"X-Samana", "description": "Create new Membership. Memberships are used to relate a user to a group.\nExample: curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H 'Accept: application/xml' -H 'Content-Type:text/xml' -X POST https://api.samanage.com/memberships.xml?group_id=1&user_ids=1", "input": [ { "name": "groupId", "type": "string", "info": "Numeric ID of the group: string", "required": true, "schema": { "title": "groupId", "type": "string" } }, { "name": "userIds", "type": "string", "info": "Numeric IDs of the users: string", "required": true, "schema": { "title": "userIds", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMembership" }, "task": true }, { "name": "deleteMemebershipById", "summary": "Delete membership.\nExample: curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H 'Accept: applicatio", "description": "Delete membership.\nExample: curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H 'Accept: application/xml' -H 'Content-Type:text/xml' -X DELETE https://api.samanage.com/memberships/1.xml", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMemebershipById" }, "task": true }, { "name": "getAudits", "summary": "List of audits", "description": "List of audits", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of audits", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "audit": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "message": { "type": "string", "example": "State changed from New to On Hold" }, "action": { "type": "string", "example": "Update" }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "source_type": { "type": "string", "example": "Incident" }, "source_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "note": { "type": "string", "example": "Audit note" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getAudits" }, "task": true }, { "name": "getAuditById", "summary": "Get audits of a specific object. Example: curl -X GET \"https://api.samanage.com/incidents/1/audits\"", "description": "Get audits of a specific object. Example: curl -X GET \"https://api.samanage.com/incidents/1/audits\" -H \"accept: application/json\" -H \"X-Samanage-Authorization: Bearer TOKEN\"", "input": [ { "name": "id", "type": "string", "info": "Numeric ID of the object to get or update: string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Source object type: string", "required": true, "schema": { "title": "objectType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of audits of a specific object", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "audit": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "message": { "type": "string", "example": "State changed from New to On Hold" }, "action": { "type": "string", "example": "Update" }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "source_type": { "type": "string", "example": "Incident" }, "source_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "account_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "user_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "email": { "type": "string", "example": "john.doe@email.com" }, "name": { "type": "string", "example": "John Doe" }, "disabled": { "type": "boolean", "example": false }, "avatar": { "type": "object", "properties": { "type": { "type": "string", "example": "initials" }, "color": { "type": "string", "example": "#1000" }, "initials": { "type": "string", "minLength": 2, "maxLength": 2, "example": "JD" } } } } }, "site": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Austin TX, USA" }, "description": { "type": "string", "example": "AUS" }, "location": { "type": "string", "example": "AUS" }, "timezone": { "type": "string", "example": "UTC-6h" } } }, "department": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Support" }, "description": { "type": "string", "example": "Support Department" }, "default_assignee_id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] } } }, "note": { "type": "string", "example": "Audit note" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAuditById" }, "task": true }, { "name": "getRisks", "summary": "List of risks", "description": "List of risks", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "List of risks", "type": "array", "items": { "type": "object", "xml": { "name": "/", "wrapped": true }, "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Risk name" }, "severity": { "type": "string", "example": "Medium" }, "category": { "type": "string", "example": "Inventory" }, "discarded": { "type": "boolean", "example": false }, "resolved": { "type": "boolean", "example": false }, "affected_assets": { "type": "object", "properties": { "id": { "readOnly": true, "oneOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 } ] }, "name": { "type": "string", "example": "Computer name" }, "type": { "type": "string", "example": "Hardware" } } }, "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }, "updated at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" } } } } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getRisks" }, "task": true }, { "name": "createAttachment", "summary": "Create a new attachment: curl -H 'X-Samanage-Authorization: Bearer TOKEN' -F 'file[attachable_typ", "description": "Create a new attachment: curl -H 'X-Samanage-Authorization: Bearer TOKEN' -F 'file[attachable_type]=PARENT_OBJECT_TYPE' -F 'file[attachable_id]=PARENT_OBJECT_ID' -F 'file[attachment]=@/PATH/TO/FILE' -H 'Accept: application/vnd.samanage.v1.3+xml' -H 'Content-Type: multipart/form-data' -X POST https://api.samanage.com/attachments.xml/json", "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": "/createAttachment" }, "task": true } ], "views": [] }