{ "openapi":"3.0.1", "info":{ "title":"SolarWinds Service Desk API", "description":"All SolarWinds Service Desk API definitions\n# General Concepts\n## Service URL\nFor US based customers, please use `https://api.samanage.com`\n\n For European based customers, please use `https://apieu.samanage.com`\n\n## Formats\n\nYou can use XML or JSON format for your request.\n\nXML Example: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+xml\" -X GET https://api.samanage.com/incidents.xml`\n\nJSON Example: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+json\" -H \"Content-Type: application/json\" -X GET https://api.samanage.com/incidents.json`\n\nFor create and update, the provided data needs to be in the correct format.\n\nXML Example: ` content `\n\nJSON Example: `{\"incident\": {\"field_to_update\": \"content\"}}`\n\nTo clear fields, use the following format:\n\nXML Example: ` `\n\nJSON Example: `{\"incident\": {\"field_to_update\": \"\"}}`\n\n## Authentication\nThe API authentication is token-based. Admins can generate a token directly from the user setup page. The token is needed by the API developer to gain access to specific items in SolarWinds accessible only via the API. When an admin re-generates their token (via the user setup page), all previously generated tokens become invalid.\n\nThe tokens are relatively long strings that resemble the following:
AAAZWV0YXkubmF0YW4rNUBzYW1hbmFnZS5jb20hbGciOiJIUzUxMiJ9.eyJ1c2VyX2ljIjoxMjU2OTQzLCJnZW5lcmF0ZWRfYXQiOiIyMDE3LTA2LTA3IDA5OjE3OjI5In0.j_H15qzJJr9vXGAHCThLEOQrE9GGbjMxZJOs5zAf_iqaGqxlIOAmvPpBx0td_C3r7dliAfXXIgdqhZHVoK1KTwAzd1
\n\nIn order to supply the API token you should pass X-Samanage-Authorization header in the following format: “Bearer API_TOKEN_STRING”.\n\nThe API call resembles the following:\n\n`curl -H \"X-Samanage-Authorization: Bearer AAAZWV0YXkubmF0YW4rNUBzYW1hbmFnZS5jb20hbGciOiJIUzUxMiJ9.eyJ1c2VyX2ljIjoxMjU2OTQzLCJnZW5lcmF0ZWRfYXQiOiIyMDE3LTA2LTA3IDA5OjE3OjI5In0.j_H15qzJJr9vXGAHCThLEOQrE9GGbjMxZJOs5zAf_iqaGqxlIOAmvPpBx0td_C3r7dliAfXXIgdqhZHVoK1KTwAzd1\" -H \"Accept: application/vnd.samanage.v2.1+json\" https://api.samanage.com/hardwares.json`\n\nIf the authentication fails, a “401 Unauthorized” message will be returned.\n## Security\nSWSD uses a secured API channel. To connect to the regional API server, use the account admin users’ token information and connect using Token-based authentication. Requests should never be transferred in plain text over the wire. Instead, use SSL version 1.2 or higher (which can be accessed using https://) to ensure that all communication with the server is encrypted and secured.\n\nTo ensure API performance and avoid denial of service, we employ API call limits based per minute as defined by the Service Desk plan of the endpoint user.\n\nPackages:\n\nProfessional Plan - 1000 calls per minute\n\nEnterprise Plan - 1500 calls per minute\n## Versioning\nClients must provide the version number they are ready to work with in the “Accept” HTTP header. A valid \"Accept\" header should specify current content type and version number. For example, “application/vnd.samanage.v2.1+xml”.\n When no “Accept” header is specified, the API will default to version 2.1.\nIf you request an API version that is no longer supported, the API will respond with an HTTP status code of “406 – Not Acceptable”.\n\nExample: \n`curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+json\" https://api.samanage.com/hardwares.json`\n## Version History\n* 1.0: Deprecated\n* 1.1: Changed structure of custom_fields_values\n* 1.2: Changed name of “incident_type” to “category” in Catalog items and Incidents\n* 1.3: Updates to incidents or comments will not send an email or a notification to the users. To enable this feature you must add add_callbacks=true to the url.\n* 2.1: Token based authentication\n## Pagination\nEvery response with a large data set will be paginated. The response will include the pagination data as headers and links (formatted as ; rel=”relative”). For example:\n\nX-Per-Page: 50\n\nX-Total-Count: 3099\n\nX-Total-Pages: 62\n\nLink: ``; rel=\"first\",\n\n``; rel=\"prev\",\n\n``; rel=\"next\",\n\n``; rel=\"last\"\n\nYou can request a specific page by providing a “page” parameter. For example, to request the third page of the hardware list, you can use the following command: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" https://api.samanage.com/hardwares.json?page=3`\n\nTo control the number of rows returned, provide the per_page parameter. For example, to request 100 rows with each results page, you can use the following command: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" https://api.samanage.com/hardwares.json?per_page=100`\n## API Entry Point\n All communication with the API begins with a list of available services. Although it is possible to get directly to a specific service URL, we advise you begin with the api.xml entry point. This ensures your program will run seamlessly if changes are made to the underlying URLs for services in future versions of the API.\n\n**Request**\n\nGET api.samanage.com/api.json \n`curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/json\" -X GET https://api.samanage.com/api.json`\n\n**Response**\n\n`[{\"name\":\"Computers List\",\"href\":\"https://api.samanage.com/hardwares.json\"},`\n\n`{\"name\":\"Helpdesk Incidents List\",\"href\":\"https://api.samanage.com/incidents.json\"},`\n\n`{\"name\":\"Changes List\",\"href\":\"https://api.samanage.com/changes.json\"},`\n\n`...]`\n## Short / long layout\nFor all APIs, you can specify the layout (short / long). This affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions.\n\nTo use, add the parameter to the request: “?layout=short” or “?layout=long”. If not present, the default is “short”.\n## Searching\nYou can search for records by using query parameters on top of the base URL. For example, when requesting a list of hardwares, you may want to limit them to only those with a specific IP address. This could be accomplished with a request like -\n\n GET api.samanage.com/hardwares.xml?ip_address=123.456*\n\nHere, ip_address is a query parameter that implements a filter where the IP equals 123.456.xxx.xxx.\n\nOther examples: `https://api.samanage.com/other_assets.json?asset_id=XXXXXXXX`, `https://api.samanage.com/hardwares.json?asset_tag=XXXXXXXX`\n## Date formats\nThe following date formats are allowed as input when updating date fields:\n\n* January 21, 2015\n* January 21 2015\n* Jan 21, 2015\n* Jan 21 2015\n* 21/1/2015\n* 2015/1/21\n* 21-1-2015\n* 2015-1-21\n*21.1.2015 \n* 2015.1.21\n## Custom fields\nTo set custom fields, use the following data format:\n\n XML Example:\n\n``\n\n`field namecontent`\n\n``\n\nJSON Example:\n\n`{\"incident\": {\"custom_fields_values\": {\"custom_fields_value\": [{\"name\": \"field name\",\"value\": \"content\"}]}}}`

", "version":"0.1.5", "x-logo":{ "url":"https://tse4.mm.bing.net/th?id=OIP.lhiASqIhZ7Ow90BTOuu5kAHaEH&pid=Api&P=0&w=301&h=168", "href":"https://support.solarwinds.com" }, "contact":{ "name":"API Support", "url":"https://support.solarwinds.com", "email":"servicedesksupport@solarwinds.com" } }, "servers":[ { "url":"https://api.samanage.com" }, { "url":"https://apieu.samanage.com" } ], "paths":{ "/incidents/{id}":{ "get":{ "operationId":"getIncidentById", "description":"Get incident", "tags":[ "Incident" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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\\ \\\"" } } } } }, "example":{ "incident":{ "id":"10000", "number":"1000", "name":"Incident Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "due_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "solutions":[ { "id":"100", "href":"https://mydomain.com/solutions/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ], "is_service_request":false, "cc":[ "jane.doe@email.com" ] } } }, "application/xml":{ "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\\ \\\"" } } } } }, "example":"\n\t1\n\tIncident Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\tJan 01,2025\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tapi\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateIncidentById", "description":"Update incident with specified fields", "tags":[ "Incident" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Incident fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "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", "", null ] } ] }, "category":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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\\ \\\"" } } } } }, "example":{ "incident":{ "name":"Incident Name", "site_id":1, "department_id":1, "description":"description", "state_id":1, "assignee":{ "email":"john.doe@email.com" }, "requester":{ "email":"john.doe@email.com" }, "priority":"High", "category":{ "name":"Facilities" }, "subcategory":{ "name":"Equipment" }, "due_at":"Jan 01,2025", "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "incidents":[ { "number":"100" } ], "problems":[ { "number":"100" } ], "changes":[ { "number":"100" } ], "solutions":[ { "number":"100" } ], "releases":[ { "number":"100" } ], "configuration_item_ids":[ "100" ], "cc":[ "jane.doe@email.com" ] } } }, "application/xml":{ "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", "", null ] } ] }, "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", "", null ] } ] }, "category":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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\\ \\\"" } } } } }, "example":"\n\tIncident Name\n\t1\n\t1\n\tdescription\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t1\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\tJan 01,2025\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n\t\n\t\t1\n\t\n\t1\n\t1\n\t1\n\t1\n\t1\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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\\ \\\"" } } } } }, "example":{ "incident":{ "id":"10000", "number":"1000", "name":"Incident Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "due_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "solutions":[ { "id":"100", "href":"https://mydomain.com/solutions/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ], "is_service_request":false, "cc":[ "jane.doe@email.com" ] } } }, "application/xml":{ "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\\ \\\"" } } } } }, "example":"\n\t1\n\tIncident Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\tJan 01,2025\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tapi\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteIncidentById", "description":"Delete incident", "tags":[ "Incident" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted incident's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/incidents":{ "get":{ "operationId":"getIncidents", "description":"List of incidents", "tags":[ "Incident" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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\\ \\\"" } } } } } }, "example":[ { "incident":{ "id":"10000", "number":"1000", "name":"Incident Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "due_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "solutions":[ { "id":"100", "href":"https://mydomain.com/solutions/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ], "is_service_request":false, "cc":[ "jane.doe@email.com" ] } } ] }, "application/xml":{ "schema":{ "description":"List of incidents", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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\\ \\\"" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tIncident Name\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tNew\n\t\tHigh\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\tCategory / Subcategory name\n\t\t\ttag1, tag2\n\t\t\t1\n\t\t\t1\n\t\t\n\t\t\n\t\t\t1\n\t\t\tCategory / Subcategory name\n\t\t\ttag1, tag2\n\t\t\t1\n\t\t\t1\n\t\t\n\t\tJan 01,2025\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\tapi\n\t\ttrue\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createIncident", "description":"Create new incident", "tags":[ "Incident" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Incident fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "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", "", null ] } ] }, "category":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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\\ \\\"" } } } } }, "example":{ "incident":{ "name":"Incident Name", "site_id":1, "department_id":1, "description":"description", "state_id":1, "assignee":{ "email":"john.doe@email.com" }, "requester":{ "email":"john.doe@email.com" }, "priority":"High", "category":{ "name":"Facilities" }, "subcategory":{ "name":"Equipment" }, "due_at":"Jan 01,2025", "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "incidents":[ { "number":"100" } ], "problems":[ { "number":"100" } ], "changes":[ { "number":"100" } ], "solutions":[ { "number":"100" } ], "releases":[ { "number":"100" } ], "configuration_item_ids":[ "100" ], "cc":[ "jane.doe@email.com" ] } } }, "application/xml":{ "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", "", null ] } ] }, "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", "", null ] } ] }, "category":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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\\ \\\"" } } } } }, "example":"\n\tIncident Name\n\t1\n\t1\n\tdescription\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t1\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\tJan 01,2025\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n\t\n\t\t1\n\t\n\t1\n\t1\n\t1\n\t1\n\t1\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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\\ \\\"" } } } } }, "example":{ "incident":{ "id":"10000", "number":"1000", "name":"Incident Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "due_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "solutions":[ { "id":"100", "href":"https://mydomain.com/solutions/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ], "is_service_request":false, "cc":[ "jane.doe@email.com" ] } } }, "application/xml":{ "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\\ \\\"" } } } } }, "example":"\n\t1\n\tIncident Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\tJan 01,2025\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tapi\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/problems/{id}":{ "get":{ "operationId":"getProblemById", "description":"Get problem", "tags":[ "Problem" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } }, "example":{ "problem":{ "id":"10000", "number":"1000", "name":"Problem Name", "description":"description", "state":"New", "root_cause":"Root cause description", "symptoms":"Symptoms description", "workaround":"workaround description", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "created_by":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tProblem Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tRoot cause description\n\tSymptoms description\n\tWorkaround description\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateProblemById", "description":"Update problem with specified fields", "tags":[ "Problem" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Problem fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":{ "problem":{ "name":"Problem Name", "site_id":1, "department_id":1, "description":"description", "state":1, "root_cause":"Root cause description", "symptoms":"Symptoms description", "workaround":"workaround description", "assignee":{ "email":"john.doe@email.com" }, "requester":{ "email":"john.doe@email.com" }, "priority":"High", "add_to_tag_list":"tag1", "remove_from_tag_list":"tag2", "tag_list":"tag1", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "incident_ids":[ 100 ], "itsm_change_ids":[ 100 ], "configuration_item_ids":[ 100 ] } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\tProblem Name\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\tNew\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\tHigh\n\tRoot cause description\n\tSymptoms description\n\tworkaround description\n\ttag1\n\ttag2\n\ttag1\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } }, "example":{ "problem":{ "id":"10000", "number":"1000", "name":"Problem Name", "description":"description", "state":"New", "root_cause":"Root cause description", "symptoms":"Symptoms description", "workaround":"workaround description", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "created_by":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tProblem Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tRoot cause description\n\tSymptoms description\n\tWorkaround description\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteProblemById", "description":"Delete problem", "tags":[ "Problem" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted problem's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/problems":{ "get":{ "operationId":"getProblems", "description":"List of problems", "tags":[ "Problem" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } ] } }, "example":[ { "problem":{ "id":"10000", "number":"1000", "name":"Problem Name", "description":"description", "state":"New", "root_cause":"Root cause description", "symptoms":"Symptoms description", "workaround":"workaround description", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "created_by":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } ] }, "application/xml":{ "schema":{ "description":"List of problems", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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" } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tProblem Name\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tNew\n\t\tHigh\n\t\tRoot cause description\n\t\tSymptoms description\n\t\tWorkaround description\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createProblem", "description":"Create new problem", "tags":[ "Problem" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Problem fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":{ "problem":{ "name":"Problem Name", "site_id":1, "department_id":1, "description":"description", "state":1, "root_cause":"Root cause description", "symptoms":"Symptoms description", "workaround":"workaround description", "assignee":{ "email":"john.doe@email.com" }, "requester":{ "email":"john.doe@email.com" }, "priority":"High", "add_to_tag_list":"tag1", "remove_from_tag_list":"tag2", "tag_list":"tag1", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "incident_ids":[ 100 ], "itsm_change_ids":[ 100 ], "configuration_item_ids":[ 100 ] } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\tProblem Name\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\tNew\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\tHigh\n\tRoot cause description\n\tSymptoms description\n\tworkaround description\n\ttag1\n\ttag2\n\ttag1\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } }, "example":{ "problem":{ "id":"10000", "number":"1000", "name":"Problem Name", "description":"description", "state":"New", "root_cause":"Root cause description", "symptoms":"Symptoms description", "workaround":"workaround description", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "created_by":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tProblem Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tRoot cause description\n\tSymptoms description\n\tWorkaround description\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/changes/{id}":{ "get":{ "operationId":"getChangeById", "description":"Get change", "tags":[ "Change" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } }, "example":{ "change":{ "id":"10000", "number":"1000", "name":"Change Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "planned_start_at":"2025-01-01T00:00:00.000+01:00", "planned_end_at":"2025-01-01T05:00:00.000+01:00", "origin":"api", "created_at":"2025-01-01T00:00:00.000+01:00", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tChange Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T05:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateChangeById", "description":"Update change with specified fields", "tags":[ "Change" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Change fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":{ "change":{ "name":"Change Name", "change_type":1, "site_id":1, "department_id":1, "description":"description", "state_id":1, "assignee":{ "email":"john.doe@email.com" }, "requester":{ "email":"john.doe@email.com" }, "priority":"High", "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "planned_start_at":"2025-01-01 00:00", "planned_end_at":"2025-01-01 05:00", "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "incidents":[ { "number":"100" } ], "problems":[ { "number":"100" } ], "releases":[ { "number":"100" } ], "configuration_item_ids":[ "100" ] } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\tChange Name\n\t1\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\tNew\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t2025-01-01 00:00\n\t2025-01-01 05:00\n\ttag1\n\ttag2\n\ttag1\n\t\n\t\t1\n\t\n\t1\n\t1\n\t1\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } }, "example":{ "change":{ "id":"10000", "number":"1000", "name":"Change Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "planned_start_at":"2025-01-01T00:00:00.000+01:00", "planned_end_at":"2025-01-01T05:00:00.000+01:00", "origin":"api", "created_at":"2025-01-01T00:00:00.000+01:00", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tChange Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T05:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteChangeById", "description":"Delete change", "tags":[ "Change" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted change's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/changes":{ "get":{ "operationId":"getChanges", "description":"List of changes", "tags":[ "Change" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } ] } }, "example":[ { "change":{ "id":"10000", "number":"1000", "name":"Change Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "planned_start_at":"2025-01-01T00:00:00.000+01:00", "planned_end_at":"2025-01-01T05:00:00.000+01:00", "origin":"api", "created_at":"2025-01-01T00:00:00.000+01:00", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } ] }, "application/xml":{ "schema":{ "description":"List of changes", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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" } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tChange Name\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tNew\n\t\tHigh\n\t\tchange plan\n\t\trollback plan\n\t\ttest plan\n\t\t2025-01-01T00:00:00.000+01:00\n\t\t2025-01-01T05:00:00.000+01:00\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t2025-01-01T00:00:00.000+01:00\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createChange", "description":"Create new change", "tags":[ "Change" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Change fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":{ "change":{ "name":"Change Name", "change_type":1, "site_id":1, "department_id":1, "description":"description", "state_id":1, "assignee":{ "email":"john.doe@email.com" }, "requester":{ "email":"john.doe@email.com" }, "priority":"High", "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "planned_start_at":"2025-01-01 00:00", "planned_end_at":"2025-01-01 05:00", "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "incidents":[ { "number":"100" } ], "problems":[ { "number":"100" } ], "releases":[ { "number":"100" } ], "configuration_item_ids":[ "100" ] } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\tChange Name\n\t1\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\tNew\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t2025-01-01 00:00\n\t2025-01-01 05:00\n\ttag1\n\ttag2\n\ttag1\n\t\n\t\t1\n\t\n\t1\n\t1\n\t1\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } }, "example":{ "change":{ "id":"10000", "number":"1000", "name":"Change Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "planned_start_at":"2025-01-01T00:00:00.000+01:00", "planned_end_at":"2025-01-01T05:00:00.000+01:00", "origin":"api", "created_at":"2025-01-01T00:00:00.000+01:00", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tChange Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T05:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/change_catalogs/{id}":{ "get":{ "operationId":"getChangeCatalogById", "description":"Get change catalog", "tags":[ "Change Catalog" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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 } } } } }, "example":{ "change_catalog":{ "id":"1", "number":"1", "name":"Change Catalog Name", "description":"description", "state":"Approved", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "default_assignee_id":1, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "origin":"api", "created_at":"2025-01-01T00:00:00.000+01:00", "show_in_portal":true } } }, "application/xml":{ "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 } } } } }, "example":"\n\t1\n\tChange Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tApproved\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateChangeCatalogById", "description":"Update change catalog with specified fields", "tags":[ "Change Catalog" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Change catalog fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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 } } } } }, "example":{ "change_catalog":{ "name":"Change Catalog Name", "change_type":1, "site_id":1, "department_id":1, "description":"description", "state_id":1, "default_assignee_id":1, "priority":"High", "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "show_in_portal":true } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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 } } } } }, "example":"\n\tChange Name\n\t1\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\tApproved\n\t1\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t\n\t\t1\n\t\n\t1\n\ttag1\n\ttag2\n\ttag1\n\ttrue\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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 } } } } }, "example":{ "change_catalog":{ "id":"1", "number":"1", "name":"Change Catalog Name", "description":"description", "state":"Approved", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "default_assignee_id":1, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "origin":"api", "created_at":"2025-01-01T00:00:00.000+01:00", "show_in_portal":true } } }, "application/xml":{ "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 } } } } }, "example":"\n\t1\n\tChange Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tApproved\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteChangeCatalogById", "description":"Delete change catalog", "tags":[ "Change Catalog" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted change catalog's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/change_catalogs":{ "get":{ "operationId":"getChangeCatalogs", "description":"List of change catalogs", "tags":[ "Change Catalog" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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 } } } } } ] } }, "example":[ { "change_catalog":{ "id":"1", "number":"1", "name":"Change Catalog Name", "description":"description", "state":"Approved", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "default_assignee_id":1, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "origin":"api", "created_at":"2025-01-01T00:00:00.000+01:00", "show_in_portal":true } } ] }, "application/xml":{ "schema":{ "description":"List of change catalogs", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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 } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tChange Name\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tApproved\n\t\tHigh\n\t\tchange plan\n\t\trollback plan\n\t\ttest plan\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t2025-01-01T00:00:00.000+01:00\n\t\ttrue\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createChangeCatalog", "description":"Create new change catalog", "tags":[ "Change Catalog" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Change catalog fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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 } } } } }, "example":{ "change_catalog":{ "name":"Change Catalog Name", "change_type":1, "site_id":1, "department_id":1, "description":"description", "state_id":1, "default_assignee_id":1, "priority":"High", "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "show_in_portal":true } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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 } } } } }, "example":"\n\tChange Name\n\t1\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\tApproved\n\t1\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t\n\t\t1\n\t\n\t1\n\ttag1\n\ttag2\n\ttag1\n\ttrue\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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 } } } } }, "example":{ "change_catalog":{ "id":"1", "number":"1", "name":"Change Catalog Name", "description":"description", "state":"Approved", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "priority":"High", "default_assignee_id":1, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "change_plan":"change plan", "rollback_plan":"rollback plan", "test_plan":"test plan", "origin":"api", "created_at":"2025-01-01T00:00:00.000+01:00", "show_in_portal":true } } }, "application/xml":{ "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 } } } } }, "example":"\n\t1\n\tChange Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tApproved\n\tHigh\n\tchange plan\n\trollback plan\n\ttest plan\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/releases/{id}":{ "get":{ "operationId":"getReleaseById", "description":"Get release", "tags":[ "Release" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "example":{ "release":{ "id":"10000", "number":"1000", "name":"Release Name", "description":"description", "state":"New", "plan":"plan description", "build":"build description", "deploy":"deploy description", "planned_start_at":"2025-01-01T00:00:00.000+01:00", "planned_end_at":"2025-01-01T05:00:00.000+01:00", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"Austin TX, USA" }, "department":{ "id":"1", "name":"Support", "description":"Support Department", "default_assignee_id":"1" }, "priority":"High", "created_by":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "approvers":[ { "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } } } }, "example":"\n\t1\n\tRelease Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tplan description\n\tbuild description\n\tdeploy description\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T05:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateReleaseById", "description":"Update release with specified fields", "tags":[ "Release" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Release fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } ] } } } } }, "example":{ "release":{ "name":"Release Name", "site_id":1, "department_id":1, "description":"description", "state":1, "plan":"plan description", "build":"build description", "deploy":"deploy description", "planned_start_at":"2025-01-01 00:00", "planned_end_at":"2025-01-01 05:00", "assignee":{ "email":"john.doe@email.com" }, "requester":{ "email":"john.doe@email.com" }, "priority":"High", "add_to_tag_list":"tag1", "remove_from_tag_list":"tag2", "tag_list":"tag1", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "approval_levels_attributes":[ { "id":"1", "approver_ids":"1", "approval_condition":"1" } ], "itsm_change_ids":[ 100 ], "configuration_item_ids":[ 100 ] } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } ] } } } } }, "example":"\n\tRelease Name\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\tNew\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\tHigh\n\tplan description\n\tbuild description\n\tdeploy description\n\t2025-01-01 00:00\n\t2025-01-01 05:00\n\ttag1\n\ttag2\n\ttag1\n\t\n\t\t1\n\t\n\t1\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "example":{ "release":{ "id":"10000", "number":"1000", "name":"Release Name", "description":"description", "state":"New", "plan":"plan description", "build":"build description", "deploy":"deploy description", "planned_start_at":"2025-01-01T00:00:00.000+01:00", "planned_end_at":"2025-01-01T05:00:00.000+01:00", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"Austin TX, USA" }, "department":{ "id":"1", "name":"Support", "description":"Support Department", "default_assignee_id":"1" }, "priority":"High", "created_by":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "approvers":[ { "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } } } }, "example":"\n\t1\n\tRelease Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tplan description\n\tbuild description\n\tdeploy description\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T05:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteReleaseById", "description":"Delete release", "tags":[ "Release" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted release's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/releases":{ "get":{ "operationId":"getRelease", "description":"List of release", "tags":[ "Release" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } } ] } }, "example":[ { "release":{ "id":"10000", "number":"1000", "name":"Release Name", "description":"description", "state":"New", "plan":"plan description", "build":"build description", "deploy":"deploy description", "planned_start_at":"2025-01-01T00:00:00.000+01:00", "planned_end_at":"2025-01-01T05:00:00.000+01:00", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"Austin TX, USA" }, "department":{ "id":"1", "name":"Support", "description":"Support Department", "default_assignee_id":"1" }, "priority":"High", "created_by":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "approvers":[ { "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } ] }, "application/xml":{ "schema":{ "description":"List of releases", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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" } } } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tRelease Name\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tNew\n\t\tHigh\n\t\tplan description\n\t\tbuild description\n\t\tdeploy description\n\t\t2025-01-01T00:00:00.000+01:00\n\t\t2025-01-01T05:00:00.000+01:00\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t2025-01-01T00:00:00.000+01:00\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createRelease", "description":"Create new release", "tags":[ "Release" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Release fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } ] } } } } }, "example":{ "release":{ "name":"Release Name", "site_id":1, "department_id":1, "description":"description", "state":1, "plan":"plan description", "build":"build description", "deploy":"deploy description", "planned_start_at":"2025-01-01 00:00", "planned_end_at":"2025-01-01 05:00", "assignee":{ "email":"john.doe@email.com" }, "requester":{ "email":"john.doe@email.com" }, "priority":"High", "add_to_tag_list":"tag1", "remove_from_tag_list":"tag2", "tag_list":"tag1", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "approval_levels_attributes":[ { "id":"1", "approver_ids":"1", "approval_condition":"1" } ], "itsm_change_ids":[ 100 ], "configuration_item_ids":[ 100 ] } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "assignee":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } ] } } } } }, "example":"\n\tRelease Name\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\tNew\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\tHigh\n\tplan description\n\tbuild description\n\tdeploy description\n\t2025-01-01 00:00\n\t2025-01-01 05:00\n\ttag1\n\ttag2\n\ttag1\n\t\n\t\t1\n\t\n\t1\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "example":{ "release":{ "id":"10000", "number":"1000", "name":"Release Name", "description":"description", "state":"New", "plan":"plan description", "build":"build description", "deploy":"deploy description", "planned_start_at":"2025-01-01T00:00:00.000+01:00", "planned_end_at":"2025-01-01T05:00:00.000+01:00", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"Austin TX, USA" }, "department":{ "id":"1", "name":"Support", "description":"Support Department", "default_assignee_id":"1" }, "priority":"High", "created_by":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "approvers":[ { "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } } } } } } }, "example":"\n\t1\n\tRelease Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\tplan description\n\tbuild description\n\tdeploy description\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T05:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2025-01-01T00:00:00.000+01:00\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/solutions/{id}":{ "get":{ "operationId":"getSolutionById", "description":"Get solution", "tags":[ "Solution" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "solution":{ "id":"10000", "number":"1000", "name":"Solution Name", "description":"description", "created_at":"2025-01-01T00:00:00.000+01:00", "creator":{ "id":"1", "name":"John Doe", "email":"john.doe@email.com" }, "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSolution Name\n\tdescription\n\t\n\t\t1\n\t\ttag name\n\t\tjohn.doe@email.com\n\t\n\t2025-01-01T00:00:00.000+01:00\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateSolutionById", "description":"Update solution with specified fields", "tags":[ "Solution" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Solution fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":{ "solution":{ "name":"Solution Name", "site_id":1, "department_id":1, "description":"description", "state":"Approved", "category":{ "name":"Facilities" }, "subcategory":{ "name":"Equipment" }, "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "incident_ids":[ 100 ] } } }, "application/xml":{ "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", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\tSolution Name\n\t1\n\t1\n\tdescription\n\tApproved\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "solution":{ "id":"10000", "number":"1000", "name":"Solution Name", "description":"description", "created_at":"2025-01-01T00:00:00.000+01:00", "creator":{ "id":"1", "name":"John Doe", "email":"john.doe@email.com" }, "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSolution Name\n\tdescription\n\t\n\t\t1\n\t\ttag name\n\t\tjohn.doe@email.com\n\t\n\t2025-01-01T00:00:00.000+01:00\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteSolutionById", "description":"Delete solution", "tags":[ "Solution" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted solution's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/solutions":{ "get":{ "operationId":"getSolutions", "description":"List of solutions", "tags":[ "Solution" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } }, "example":[ { "solution":{ "id":"10000", "number":"1000", "name":"Solution Name", "description":"description", "created_at":"2025-01-01T00:00:00.000+01:00", "creator":{ "id":"1", "name":"John Doe", "email":"john.doe@email.com" }, "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ] } } ] }, "application/xml":{ "schema":{ "description":"List of solutions", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tSolution Name\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\ttag name\n\t\t\tjohn.doe@email.com\n\t\t\n\t\t2025-01-01T00:00:00.000+01:00\n\t\tapi\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createSolution", "description":"Create new solution", "tags":[ "Solution" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"solution fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":{ "solution":{ "name":"Solution Name", "site_id":1, "department_id":1, "description":"description", "state":"Approved", "category":{ "name":"Facilities" }, "subcategory":{ "name":"Equipment" }, "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "incident_ids":[ 100 ] } } }, "application/xml":{ "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", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\tSolution Name\n\t1\n\t1\n\tdescription\n\tApproved\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "solution":{ "id":"10000", "number":"1000", "name":"Solution Name", "description":"description", "created_at":"2025-01-01T00:00:00.000+01:00", "creator":{ "id":"1", "name":"John Doe", "email":"john.doe@email.com" }, "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSolution Name\n\tdescription\n\t\n\t\t1\n\t\ttag name\n\t\tjohn.doe@email.com\n\t\n\t2025-01-01T00:00:00.000+01:00\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/catalog_items/{id}":{ "get":{ "operationId":"getCatalogItemById", "description":"Get catalog item", "tags":[ "Catalog Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "catalog_item":{ "id":"10000", "number":"1000", "name":"CI Name", "description":"description", "created_at":"2025-01-01T00:00:00.000+01:00", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "expected_delivery_time":"1 day", "currency":"USD", "price":"1", "show_price":true, "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tCI Name\n\tdescription\n\t1 day\n\tUSD\n\t1\n\ttrue\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateCatalogItemById", "description":"Update catalog item with specified fields", "tags":[ "Catalog Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Catalog item fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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" } } } } }, "example":{ "catalog_item":{ "name":"CI Name", "site_id":1, "department_id":1, "description":"description", "state":"Approved", "default_assignee_id":"1", "category":{ "name":"Facilities" }, "subcategory":{ "name":"Equipment" }, "expected_delivery_time":"1 day", "currency":"USD", "price":"1", "show_price":true, "add_to_tag_list":"tag1", "remove_from_tag_list":"tag2", "tag_list":"tag1" } } }, "application/xml":{ "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", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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" } } } } }, "example":"\n\tCI Name\n\t1\n\t1\n\tdescription\n\tApproved\n\t1\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1 day\n\tUSD\n\t1\n\t1\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "catalog_item":{ "id":"10000", "number":"1000", "name":"CI Name", "description":"description", "created_at":"2025-01-01T00:00:00.000+01:00", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "expected_delivery_time":"1 day", "currency":"USD", "price":"1", "show_price":true, "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tCI Name\n\tdescription\n\t1 day\n\tUSD\n\t1\n\ttrue\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteCatalogItemById", "description":"Delete catalog item", "tags":[ "Catalog Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted catalog item's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/catalog_items":{ "get":{ "operationId":"getCatalogItems", "description":"List of catalog items", "tags":[ "Catalog Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } }, "example":[ { "catalog_item":{ "id":"10000", "number":"1000", "name":"CI Name", "description":"description", "created_at":"2025-01-01T00:00:00.000+01:00", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "expected_delivery_time":"1 day", "currency":"USD", "price":"1", "show_price":true, "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ] } } ] }, "application/xml":{ "schema":{ "description":"List of catalog items", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tCI Name\n\t\tdescription\n\t\t1 day\n\t\tUSD\n\t\t1\n\t\ttrue\n\t\t2025-01-01T00:00:00.000+01:00\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\t\n\t\t\t1\n\t\t\tCategory / Subcategory name\n\t\t\ttag1, tag2\n\t\t\t1\n\t\t\t1\n\t\t\n\t\t\n\t\t\t1\n\t\t\tCategory / Subcategory name\n\t\t\ttag1, tag2\n\t\t\t1\n\t\t\t1\n\t\t\n\t\tapi\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createCatalogItem", "description":"Create new catalog item", "tags":[ "Catalog Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Catalog Item fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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" } } } } }, "example":{ "catalog_item":{ "name":"CI Name", "site_id":1, "department_id":1, "description":"description", "state":"Approved", "default_assignee_id":"1", "category":{ "name":"Facilities" }, "subcategory":{ "name":"Equipment" }, "expected_delivery_time":"1 day", "currency":"USD", "price":"1", "show_price":true, "add_to_tag_list":"tag1", "remove_from_tag_list":"tag2", "tag_list":"tag1" } } }, "application/xml":{ "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", "", null ] } ] }, "subcategory":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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" } } } } }, "example":"\n\tCI Name\n\t1\n\t1\n\tdescription\n\tApproved\n\t1\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1 day\n\tUSD\n\t1\n\t1\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "catalog_item":{ "id":"10000", "number":"1000", "name":"CI Name", "description":"description", "created_at":"2025-01-01T00:00:00.000+01:00", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "expected_delivery_time":"1 day", "currency":"USD", "price":"1", "show_price":true, "tags":[ { "id":1, "name":"tag1", "taggings_count":1 } ], "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tCI Name\n\tdescription\n\t1 day\n\tUSD\n\t1\n\ttrue\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/catalog_items/{id}/service_requests":{ "post":{ "operationId":"createServiceRequest", "description":"Request a Service", "tags":[ "Service Request" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "description":"Service Request fields to fill", "content":{ "application/json":{ "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", "", null ] } ] } } }, { "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", "", null ] } ] } } } } ] } } } } }, "example":{ "incident":{ "site_id":"1", "department_id":"1", "requester_name":"john.doe@email.com", "priority":"High", "due_at":"Jan 01,2025", "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "request_variables_attributes":[ { "name":"Variable name", "value":"Content" }, { "name":"User Variable", "user_value":{ "email":"john.doe@email.com" } }, { "name":"MultyPickList variable", "value":"option1#dlmtr#option2" } ] } } }, "application/xml":{ "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", "", null ] } ] } } }, { "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", "", null ] } ] } } } } ] } } } } }, "example":"\n\t1\n\t1\n\tjohn.doe@email.com\n\tHigh\n\tJan 01,2025\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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\\ \\\"" } } } } }, "example":{ "incident":{ "id":"10000", "number":"1000", "name":"Incident Name", "description":"description", "state":"New", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "category":{ "id":"10000", "name":"Facilities", "default_tags":"tagA, tagB", "parent_id":"null", "default_assignee_id":"1" }, "subcategory":{ "id":"1000", "name":"Equipment", "default_tags":"", "parent_id":"10000", "default_assignee_id":"1" }, "priority":"High", "assignee":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "requester":{ "id":"1", "account_id":"1", "user_id":"1", "email":"john.doe@email.com", "name":"John Doe", "disabled":false, "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "due_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "solutions":[ { "id":"100", "href":"https://mydomain.com/solutions/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ], "is_service_request":false, "cc":[ "jane.doe@email.com" ] } } }, "application/xml":{ "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\\ \\\"" } } } } }, "example":"\n\t1\n\tIncident Name\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tNew\n\tHigh\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\t\n\t\t1\n\t\tCategory / Subcategory name\n\t\ttag1, tag2\n\t\t1\n\t\t1\n\t\n\tJan 01,2025\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tapi\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } } }, "/configuration_items/{id}":{ "get":{ "operationId":"getConfigurationItemById", "description":"Get configuration item", "tags":[ "Configuration Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "configuration_item":{ "id":"10000", "number":"1000", "name":"Configuration Item Name", "description":"description", "asset_tag":"ConfigurationItemTag", "type":{ "id":1, "name":"Building", "description":"Configuration Item - Building", "parent_id":1, "custom":false, "updated_at":"2025-01-01T00:00:00.000+01:00", "icon_name":"BUILDING" }, "type_id":1, "state":"Active", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "manager_id":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "user_id":{ "group_id":"1", "is_user":"true", "id":"1", "name":"Jane Doe", "email":"jane.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"1000", "custom_field_id":"1", "name":"field name", "value":"content", "options":"", "type_name":"Text" } ], "updated_at":"2025-01-01T00:00:00.000+01:00", "created_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "purchase_orders":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tCI Name\n\tdescription\n\t\n\t\t1\n\t\tBuilding\n\t\tConfiguration Item - Building\n\t\t1\n\t\ttrue\n\t\tBUILDING\n\t\t2025-01-01T00:00:00.000+01:00\n\t\n\t1\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tActive\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateConfigurationItemById", "description":"Update configuration item with specified fields", "tags":[ "Configuration Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Configuration Item fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "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", "", null ] } ] }, "user":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":{ "configuration_item":{ "name":"Configuration Item Name", "description":"Description", "type":{ "name":"Building" }, "type_id":1, "asset_tag":"ConfigurationItemTag", "site_id":1, "department_id":1, "state":"Active", "manager":{ "email":"john.doe@email.com" }, "user":{ "email":"jane.doe@email.com" }, "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":"1", "custom_field_id":1, "value":"content" } ], "incident_ids":[ 100 ], "problem_ids":[ 100 ], "itsm_change_ids":[ 100 ], "release_ids":[ 100 ], "purchase_order_ids":[ 100 ], "configuration_item_ids":[ 100 ] } } }, "application/xml":{ "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", "", null ] } ] }, "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", "", null ] } ] }, "user":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\t\n\t\tObject Name\n\t\n\t1\n\tCI Name\n\tdescription\n\tConfiguration Item Tag\n\t1\n\t1\n\tActive\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "configuration_item":{ "id":"10000", "number":"1000", "name":"Configuration Item Name", "description":"description", "asset_tag":"ConfigurationItemTag", "type":{ "id":1, "name":"Building", "description":"Configuration Item - Building", "parent_id":1, "custom":false, "updated_at":"2025-01-01T00:00:00.000+01:00", "icon_name":"BUILDING" }, "type_id":1, "state":"Active", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "manager_id":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "user_id":{ "group_id":"1", "is_user":"true", "id":"1", "name":"Jane Doe", "email":"jane.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"1000", "custom_field_id":"1", "name":"field name", "value":"content", "options":"", "type_name":"Text" } ], "updated_at":"2025-01-01T00:00:00.000+01:00", "created_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "purchase_orders":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tCI Name\n\tdescription\n\t\n\t\t1\n\t\tBuilding\n\t\tConfiguration Item - Building\n\t\t1\n\t\ttrue\n\t\tBUILDING\n\t\t2025-01-01T00:00:00.000+01:00\n\t\n\t1\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tActive\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteConfigurationItemById", "description":"Delete configurationitem", "tags":[ "Configuration Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted configuration item's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/configuration_items":{ "get":{ "operationId":"getConfigurationItems", "description":"List of configuration items", "tags":[ "Configuration Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } }, "example":[ { "configuration_item":{ "id":"10000", "number":"1000", "name":"Configuration Item Name", "description":"description", "asset_tag":"ConfigurationItemTag", "type":{ "id":1, "name":"Building", "description":"Configuration Item - Building", "parent_id":1, "custom":false, "updated_at":"2025-01-01T00:00:00.000+01:00", "icon_name":"BUILDING" }, "type_id":1, "state":"Active", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "manager_id":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "user_id":{ "group_id":"1", "is_user":"true", "id":"1", "name":"Jane Doe", "email":"jane.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"1000", "custom_field_id":"1", "name":"field name", "value":"content", "options":"", "type_name":"Text" } ], "updated_at":"2025-01-01T00:00:00.000+01:00", "created_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "purchase_orders":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } ] }, "application/xml":{ "schema":{ "description":"List of configuration items", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tCI Name\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tBuilding\n\t\t\tConfiguration Item - Building\n\t\t\t1\n\t\t\ttrue\n\t\t\tBUILDING\n\t\t\t2025-01-01T00:00:00.000+01:00\n\t\t\n\t\t1\n\t\t2025-01-01T00:00:00.000+01:00\n\t\t2025-01-01T00:00:00.000+01:00\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tActive\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\tapi\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createConfigurationItem", "description":"Create new configurationitem", "tags":[ "Configuration Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Configuration Item fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "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", "", null ] } ] }, "user":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":{ "configuration_item":{ "name":"Configuration Item Name", "description":"Description", "type":{ "name":"Building" }, "type_id":1, "asset_tag":"ConfigurationItemTag", "site_id":1, "department_id":1, "state":"Active", "manager":{ "email":"john.doe@email.com" }, "user":{ "email":"jane.doe@email.com" }, "add_to_tag_list":"tag1, tag2", "remove_from_tag_list":"tag3", "tag_list":"tag1, tag2", "custom_fields_values_attributes":[ { "id":"1", "custom_field_id":1, "value":"content" } ], "incident_ids":[ 100 ], "problem_ids":[ 100 ], "itsm_change_ids":[ 100 ], "release_ids":[ 100 ], "purchase_order_ids":[ 100 ], "configuration_item_ids":[ 100 ] } } }, "application/xml":{ "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", "", null ] } ] }, "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", "", null ] } ] }, "user":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\t\n\t\tObject Name\n\t\n\t1\n\tCI Name\n\tdescription\n\tConfiguration Item Tag\n\t1\n\t1\n\tActive\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\ttag1, tag2\n\ttag3\n\ttag1, tag2\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "configuration_item":{ "id":"10000", "number":"1000", "name":"Configuration Item Name", "description":"description", "asset_tag":"ConfigurationItemTag", "type":{ "id":1, "name":"Building", "description":"Configuration Item - Building", "parent_id":1, "custom":false, "updated_at":"2025-01-01T00:00:00.000+01:00", "icon_name":"BUILDING" }, "type_id":1, "state":"Active", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "manager_id":{ "group_id":"1", "is_user":"true", "id":"1", "name":"John Doe", "email":"john.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "user_id":{ "group_id":"1", "is_user":"true", "id":"1", "name":"Jane Doe", "email":"jane.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" } }, "custom_fields_values":[ { "id":"1000", "custom_field_id":"1", "name":"field name", "value":"content", "options":"", "type_name":"Text" } ], "updated_at":"2025-01-01T00:00:00.000+01:00", "created_at":"2025-01-01T00:00:00.000+01:00", "origin":"api", "incidents":[ { "id":"100", "href":"https://mydomain.com/incidents/100" } ], "problems":[ { "id":"100", "href":"https://mydomain.com/problems/100" } ], "changes":[ { "id":"100", "href":"https://mydomain.com/changes/100" } ], "releases":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "purchase_orders":[ { "id":"100", "href":"https://mydomain.com/releases/100" } ], "configuration_items":[ { "id":"100", "href":"https://mydomain.com/configuration_items/100" } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tCI Name\n\tdescription\n\t\n\t\t1\n\t\tBuilding\n\t\tConfiguration Item - Building\n\t\t1\n\t\ttrue\n\t\tBUILDING\n\t\t2025-01-01T00:00:00.000+01:00\n\t\n\t1\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tActive\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tapi\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/configuration_items/{id}/append_multiple_dependent_assets":{ "put":{ "operationId":"appendDependentAssets", "description":"Append multiple dependent assets", "tags":[ "Configuration Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "description":"Dependencies fields to fill", "content":{ "application/json":{ "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 ] } } } } }, "application/xml":{ "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 ] } } } }, "example":null } } }, "responses":{ "200":{ "description":"Dependency added successfully" }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } } }, "/asset_links/delete_asset_link_by_id":{ "put":{ "operationId":"deleteAssetLink", "description":"Delete dpendency by id", "tags":[ "Configuration Item" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "description":"Dependencies fields to fill", "content":{ "application/json":{ "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" } } } }, "application/xml":{ "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" } } }, "example":"1\n1\nConfigurationItem" } } }, "responses":{ "200":{ "description":"Dependency removed successfully" }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } } }, "/users/{id}":{ "get":{ "operationId":"getUserById", "description":"Get user", "tags":[ "User" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "user":{ "id":"10000", "name":"John Doe", "title":"Support Agent", "disabled":false, "email":"john.doe@email.com", "created_at":"2030-01-01T00:00:00.000+00:00", "phone":"+10000000", "mobile_phone":"+10000000", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "role":{ "id":1, "name":"Requester", "description":"Requester role.", "portal":true, "show_my_tasks":true }, "group_ids":[ 1 ], "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" }, "reports_to":{ "group_id":"1", "is_user":"true", "id":"100", "name":"Jane Doe", "email":"jane.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4166", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tJohn Doe\n\tSupport Agent\n\tjohn.doe@email.com\n\t+10000000\n\t+10000000\n\t\n\t\t1\n\t\tRequester\n\t\tRequester role\n\t\ttrue\n\t\ttrue\n\t\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t\n\t\tinitials\n\t\t#1000\n\t\tJD\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2020-01-01T00:00:00.000+00:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateUserById", "description":"Update user with specified fields", "tags":[ "User" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"User fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "site":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } } } } } }, "example":{ "user":{ "name":"John Doe", "email":"john.doe@email.com", "title":"Support Agent", "site":{ "name":"AUS" }, "department":{ "name":"Support" }, "role":{ "name":"Requester" }, "phone":"+10000000", "mobile_phone":"+10000000", "reports_to":{ "email":"jane.doe@email.com" }, "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] } } } }, "application/xml":{ "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", "", null ] } ] }, "site":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } } } } } }, "example":"\n\tJohn Doe\n\tSupport Agent\n\tjohn.doe@email.com\n\ttrue\n\t+10000000\n\t+10000000\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t\n\t\t1\n\t\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "user":{ "id":"10000", "name":"John Doe", "title":"Support Agent", "disabled":false, "email":"john.doe@email.com", "created_at":"2030-01-01T00:00:00.000+00:00", "phone":"+10000000", "mobile_phone":"+10000000", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "role":{ "id":1, "name":"Requester", "description":"Requester role.", "portal":true, "show_my_tasks":true }, "group_ids":[ 1 ], "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" }, "reports_to":{ "group_id":"1", "is_user":"true", "id":"100", "name":"Jane Doe", "email":"jane.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4166", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tJohn Doe\n\tSupport Agent\n\tjohn.doe@email.com\n\t+10000000\n\t+10000000\n\t\n\t\t1\n\t\tRequester\n\t\tRequester role\n\t\ttrue\n\t\ttrue\n\t\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t\n\t\tinitials\n\t\t#1000\n\t\tJD\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2020-01-01T00:00:00.000+00:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteUserById", "description":"Delete user", "tags":[ "User" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted user" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/users":{ "get":{ "operationId":"getUsers", "description":"List of Users", "tags":[ "User" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } ] } }, "example":[ { "user":{ "id":"10000", "name":"John Doe", "title":"Support Agent", "disabled":false, "email":"john.doe@email.com", "created_at":"2030-01-01T00:00:00.000+00:00", "phone":"+10000000", "mobile_phone":"+10000000", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "role":{ "id":1, "name":"Requester", "description":"Requester role.", "portal":true, "show_my_tasks":true }, "group_ids":[ 1 ], "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" }, "reports_to":{ "group_id":"1", "is_user":"true", "id":"100", "name":"Jane Doe", "email":"jane.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4166", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ] } } ] }, "application/xml":{ "schema":{ "description":"List of users", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tJohn Doe\n\t\tSupport Agent\n\t\tjohn.doe@email.com\n\t\t+10000000\n\t\t+10000000\n\t\t\n\t\t\t1\n\t\t\tRequester\n\t\t\tRequester role\n\t\t\ttrue\n\t\t\ttrue\n\t\t\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t2020-01-01T00:00:00.000+00:00\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createUser", "description":"Create new user", "tags":[ "User" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"User fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "site":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } } } } } }, "example":{ "user":{ "name":"John Doe", "email":"john.doe@email.com", "title":"Support Agent", "site":{ "name":"AUS" }, "department":{ "name":"Support" }, "role":{ "name":"Requester" }, "phone":"+10000000", "mobile_phone":"+10000000", "reports_to":{ "email":"jane.doe@email.com" }, "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] } } } }, "application/xml":{ "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", "", null ] } ] }, "site":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } } } } } }, "example":"\n\tJohn Doe\n\tSupport Agent\n\tjohn.doe@email.com\n\ttrue\n\t+10000000\n\t+10000000\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t\n\t\t1\n\t\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "user":{ "id":"10000", "name":"John Doe", "title":"Support Agent", "disabled":false, "email":"john.doe@email.com", "created_at":"2030-01-01T00:00:00.000+00:00", "phone":"+10000000", "mobile_phone":"+10000000", "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "role":{ "id":1, "name":"Requester", "description":"Requester role.", "portal":true, "show_my_tasks":true }, "group_ids":[ 1 ], "avatar":{ "type":"initials", "color":"#fd4165", "initials":"JD" }, "reports_to":{ "group_id":"1", "is_user":"true", "id":"100", "name":"Jane Doe", "email":"jane.doe@email.com", "avatar":{ "type":"initials", "color":"#fd4166", "initials":"JD" } }, "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ] } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tJohn Doe\n\tSupport Agent\n\tjohn.doe@email.com\n\t+10000000\n\t+10000000\n\t\n\t\t1\n\t\tRequester\n\t\tRequester role\n\t\ttrue\n\t\ttrue\n\t\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t\n\t\tinitials\n\t\t#1000\n\t\tJD\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t2020-01-01T00:00:00.000+00:00\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/sites/{id}":{ "get":{ "operationId":"getSiteById", "description":"Get site", "tags":[ "Site" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tAustin TX, USA\n\tAUS\n\tDescription Austin TX, USA\n\tTexas\n\ten\n\t1\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateSiteById", "description":"Update site with specified fields", "tags":[ "Site" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Site fields to update", "content":{ "application/json":{ "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 } ] } } } } } } } }, "application/xml":{ "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 } ] } } } } } } }, "example":"\n\tAustin TX, USA\n\tAUS\n\tDescription Austin TX, USA\n\tTexas\n\ten\n\t1\n\t1\n\t\n\t\t1\n\t\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tAustin TX, USA\n\tAUS\n\tDescription Austin TX, USA\n\tTexas\n\ten\n\t1\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteSiteById", "description":"Delete site", "tags":[ "Site" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted site" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/sites":{ "get":{ "operationId":"getSites", "description":"List of Sites", "tags":[ "Site" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } ] } } }, "application/xml":{ "schema":{ "description":"List of sites", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tDescription Austin TX, USA\n\t\tTexas\n\t\ten\n\t\t1\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createSite", "description":"Create new site", "tags":[ "Site" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Site fields to fill", "content":{ "application/json":{ "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 } ] } } } } } } } }, "application/xml":{ "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 } ] } } } } } } }, "example":"\n\tAustin TX, USA\n\tAUS\n\tDescription Austin TX, USA\n\tTexas\n\ten\n\t1\n\t1\n\t\n\t\t1\n\t\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tAustin TX, USA\n\tAUS\n\tDescription Austin TX, USA\n\tTexas\n\ten\n\t1\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/departments/{id}":{ "get":{ "operationId":"getDepartmentById", "description":"Get department", "tags":[ "Department" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSupport\n\tSupport Department\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateDepartmentById", "description":"Update department with specified fields", "tags":[ "Department" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Department fields to update", "content":{ "application/json":{ "schema":{ "type":"object", "xml":{ "name":"/" }, "properties":{ "department":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"Support" }, "description":{ "type":"string", "example":"Support Department" } } } } } }, "application/xml":{ "schema":{ "type":"object", "xml":{ "name":"/" }, "properties":{ "department":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"Support" }, "description":{ "type":"string", "example":"Support Department" } } } } }, "example":"\n\tSupport\n\tSupport Department\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSupport\n\tSupport Department\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteDepartmentById", "description":"Delete department", "tags":[ "Department" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted department" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/departments":{ "get":{ "operationId":"getDepartments", "description":"List of Departments", "tags":[ "Department" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } ] } } }, "application/xml":{ "schema":{ "description":"List of departments", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createDepartment", "description":"Create new department", "tags":[ "Department" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Department fields to fill", "content":{ "application/json":{ "schema":{ "type":"object", "xml":{ "name":"/" }, "properties":{ "department":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Support" }, "description":{ "type":"string", "example":"Support Department" } } } } } }, "application/xml":{ "schema":{ "type":"object", "xml":{ "name":"/" }, "properties":{ "department":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Support" }, "description":{ "type":"string", "example":"Support Department" } } } } }, "example":"\n\tSupport\n\tSupport Department\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSupport\n\tSupport Department\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/roles/{id}":{ "get":{ "operationId":"getRoleById", "description":"Get role", "tags":[ "Role" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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 } } } } } }, "application/xml":{ "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 } } } } }, "example":"\n\t1\n\tSupport Agent\n\tSupport Agent role\n\ttrue\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateRoleById", "description":"Update role with specified fields", "tags":[ "Role" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Role fields to update", "content":{ "application/json":{ "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 } } } } } }, "application/xml":{ "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 } } } } }, "example":"\n\tSupport Agent\n\tSupport Agent role\n\ttrue\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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 } } } } } }, "application/xml":{ "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 } } } } }, "example":"\n\t1\n\tSupport Agent\n\tSupport Agent role\n\ttrue\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteRoleById", "description":"Delete role", "tags":[ "Role" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted role" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/roles":{ "get":{ "operationId":"getRoles", "description":"List of roles", "tags":[ "Role" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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 } } } } } ] } } }, "application/xml":{ "schema":{ "description":"List of role", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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 } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tSupport Agent\n\t\tSupport Agent role\n\t\ttrue\n\t\ttrue\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createRole", "description":"Create new role", "tags":[ "Role" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Role fields to fill", "content":{ "application/json":{ "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 } } } } } }, "application/xml":{ "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 } } } } }, "example":"\n\tSupport Agent\n\tSupport Agent role\n\ttrue\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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 } } } } } }, "application/xml":{ "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 } } } } }, "example":"\n\t1\n\tSupport Agent\n\tSupport Agent role\n\ttrue\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/groups/{id}":{ "get":{ "operationId":"getGroupById", "description":"Get group", "tags":[ "Group" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tGroup Name\n\tGroup Description\n\ttrue\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\tinitials\n\t\t#1000\n\t\tJD\n\t\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateGroupById", "description":"Update group with specified fields", "tags":[ "Group" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Group fields to update", "content":{ "application/json":{ "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } } }, "application/xml":{ "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } }, "example":"\n\tGroup Name\n\tGroup Description\n\t1\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tGroup Name\n\tGroup Description\n\ttrue\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\tinitials\n\t\t#1000\n\t\tJD\n\t\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteGroupById", "description":"Delete group", "tags":[ "Group" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted group" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/groups":{ "get":{ "operationId":"getGroups", "description":"List of groups", "tags":[ "Group" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } ] } } }, "application/xml":{ "schema":{ "description":"List of groups", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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" } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tGroup Name\n\t\tGroup Description\n\t\ttrue\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\ttrue\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createGroup", "description":"Create new group", "tags":[ "Group" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Group fields to fill", "content":{ "application/json":{ "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } } }, "application/xml":{ "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } }, "example":"\n\tGroup Name\n\tGroup Description\n\t1\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tGroup Name\n\tGroup Description\n\ttrue\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\tinitials\n\t\t#1000\n\t\tJD\n\t\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/categories/{id}":{ "get":{ "operationId":"getCategoryById", "description":"Get category", "tags":[ "Category" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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 } ] } } } } } }, "application/xml":{ "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 } ] } } } } }, "example":"\n\t1\n\tEquipment\n\t1\n\tequipment\n\t1\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateCategoryById", "description":"Update category with specified fields", "tags":[ "Category" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Category fields to update", "content":{ "application/json":{ "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", "", null ] } ], "example":{ "name":"Facilities" } }, "default_assignee_id":{ "anyOf":[ { "type":"string", "example":"1" }, { "type":"integer", "example":1 } ] }, "default_tags":{ "type":"string", "example":"equipment" } } } } } }, "application/xml":{ "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", "", null ] } ], "example":{ "name":"Facilities" } }, "default_assignee_id":{ "anyOf":[ { "type":"string", "example":"1" }, { "type":"integer", "example":1 } ] }, "default_tags":{ "type":"string", "example":"equipment" } } } } }, "example":"\n\tEquipment\n\t\n\t\tObject Name\n\t\n\t1\n\tequipment\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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 } ] } } } } } }, "application/xml":{ "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 } ] } } } } }, "example":"\n\t1\n\tEquipment\n\t1\n\tequipment\n\t1\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteCategoryById", "description":"Delete category", "tags":[ "Category" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted category" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/categories":{ "get":{ "operationId":"getCategories", "description":"List of categories", "tags":[ "Category" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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 } ] } } } } } ] } } }, "application/xml":{ "schema":{ "description":"List of categories", "type":"array", "xml":{ "name":"/", "wrapped":true }, "items":{ "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 } ] } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tEquipment\n\t\t1\n\t\tequipment\n\t\t1\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createCategory", "description":"Create new category", "tags":[ "Category" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Category fields to fill", "content":{ "application/json":{ "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", "", null ] } ], "example":{ "name":"Facilities" } }, "default_assignee_id":{ "anyOf":[ { "type":"string", "example":"1" }, { "type":"integer", "example":1 } ] }, "default_tags":{ "type":"string", "example":"equipment" } } } } } }, "application/xml":{ "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", "", null ] } ], "example":{ "name":"Facilities" } }, "default_assignee_id":{ "anyOf":[ { "type":"string", "example":"1" }, { "type":"integer", "example":1 } ] }, "default_tags":{ "type":"string", "example":"equipment" } } } } }, "example":"\n\tEquipment\n\t\n\t\tObject Name\n\t\n\t1\n\tequipment\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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 } ] } } } } } }, "application/xml":{ "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 } ] } } } } }, "example":"\n\t1\n\tEquipment\n\t1\n\tequipment\n\t1\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/hardwares/{id}":{ "get":{ "operationId":"getHardwareById", "description":"Get hardware", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "hardware":{ "id":1, "name":"Hardware Name", "description":"description", "category":{ "id":1, "name":"Laptop" }, "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "ip":"0.0.0.0", "external_ip":"0.0.0.0", "status":{ "name":"Operational" }, "technical_contact":{ "email":"john.doe@email.com" }, "owner":{ "email":"john.doe@email.com" }, "notes":"Hardware notes", "barcode_encoding_format":"Code1A", "cpu":"hardware_cpu", "processor_speed":"processor_speed", "memory":1024, "swap":"MB", "operating_system":"Windows 10", "domain":"domain description", "active_directory":"Workgroup of the OS", "address":"Site 1, Building 1, Department 1", "longitude":"0.000", "latitude":"0.000", "product_number":"1", "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "bioses":[ { "id":1, "manufacturer":"Dell", "ssn":"1", "model":"model description", "version":"1", "bios_date":"2020-01-01 00:00", "reported_at":"2020-01-01 00:00" } ], "tag":"tag", "asset_tag":"1" } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tHardware Name\n\t0.0.0.0\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\t\n\t\t1\n\t\tLaptop\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tHardware notes\n\tCode1A\n\thardware_cpu\n\tprocessor_speed\n\t1024\n\tMB\n\tdomain description\n\tWindows 10\n\tWorkgroup of the OS\n\t
Site 1, Building 1, Department 1
\n\t0.000\n\t0.000\n\t1\n\thardware tag\n\t1\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateHardwareById", "description":"Update hardware with specified fields", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Hardware fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "technical_contact":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "owner":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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 } ] } } } } }, "example":{ "hardware":{ "name":"Hardware Name", "description":"description", "category":{ "name":"Laptop" }, "site_id":1, "department_id":1, "ip_address":"0.0.0.0", "external_ip":"0.0.0.0", "status":{ "name":"Operational" }, "technical_contact":{ "email":"john.doe@email.com" }, "owner":{ "email":"john.doe@email.com" }, "notes":"Hardware notes", "barcode_encoding_format":"Code1A", "cpu":"hardware_cpu", "processor_speed":"processor_speed", "memory":1024, "swap":"MB", "operating_system":"Windows 10", "domain":"domain description", "active_directory":"Workgroup of the OS", "address":"Site 1, Building 1, Department 1", "longitude":"0.000", "latitude":"0.000", "product_number":"1", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "bio":{ "manufacturer":"Dell", "ssn":"1", "model":"model description", "version":"1", "bios_date":"2020-01-01 00:00" }, "tag":"tag", "asset_tag":1 } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "technical_contact":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "owner":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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 } ] } } } } }, "example":"\n\tHardware Name\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\t\n\t\tObject Name\n\t\n\t0.0.0.0\n\t0.0.0.0\n\t\n\t\tObject Name\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\tHardware notes\n\tCode1A\n\thardware_cpu\n\t1024\n\tMB\n\tdomain description\n\tWindows 10\n\tWorkgroup of the OS\n\t
Site 1, Building 1, Department 1
\n\t0.000\n\t0.000\n\t1\n\t\n\t\t1\n\t\n\t1\n\t\n\t\tDell\n\t\t1\n\t\tmodel description\n\t\t1\n\t\t2020-01-01 00:00\n\t\n\thardware tag\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "hardware":{ "id":1, "name":"Hardware Name", "description":"description", "category":{ "id":1, "name":"Laptop" }, "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "ip":"0.0.0.0", "external_ip":"0.0.0.0", "status":{ "name":"Operational" }, "technical_contact":{ "email":"john.doe@email.com" }, "owner":{ "email":"john.doe@email.com" }, "notes":"Hardware notes", "barcode_encoding_format":"Code1A", "cpu":"hardware_cpu", "processor_speed":"processor_speed", "memory":1024, "swap":"MB", "operating_system":"Windows 10", "domain":"domain description", "active_directory":"Workgroup of the OS", "address":"Site 1, Building 1, Department 1", "longitude":"0.000", "latitude":"0.000", "product_number":"1", "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "bioses":[ { "id":1, "manufacturer":"Dell", "ssn":"1", "model":"model description", "version":"1", "bios_date":"2020-01-01 00:00", "reported_at":"2020-01-01 00:00" } ], "tag":"tag", "asset_tag":"1" } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tHardware Name\n\t0.0.0.0\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\t\n\t\t1\n\t\tLaptop\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tHardware notes\n\tCode1A\n\thardware_cpu\n\tprocessor_speed\n\t1024\n\tMB\n\tdomain description\n\tWindows 10\n\tWorkgroup of the OS\n\t
Site 1, Building 1, Department 1
\n\t0.000\n\t0.000\n\t1\n\thardware tag\n\t1\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteHardwareById", "description":"Delete hardware", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted hardware's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/hardwares":{ "get":{ "operationId":"getHardwares", "description":"List of hardwares", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } }, "example":[ { "hardware":{ "id":1, "name":"Hardware Name", "description":"description", "category":{ "id":1, "name":"Laptop" }, "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "ip":"0.0.0.0", "external_ip":"0.0.0.0", "status":{ "name":"Operational" }, "technical_contact":{ "email":"john.doe@email.com" }, "owner":{ "email":"john.doe@email.com" }, "notes":"Hardware notes", "barcode_encoding_format":"Code1A", "cpu":"hardware_cpu", "processor_speed":"processor_speed", "memory":1024, "swap":"MB", "operating_system":"Windows 10", "domain":"domain description", "active_directory":"Workgroup of the OS", "address":"Site 1, Building 1, Department 1", "longitude":"0.000", "latitude":"0.000", "product_number":"1", "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "bioses":[ { "id":1, "manufacturer":"Dell", "ssn":"1", "model":"model description", "version":"1", "bios_date":"2020-01-01 00:00", "reported_at":"2020-01-01 00:00" } ], "tag":"tag", "asset_tag":"1" } } ] }, "application/xml":{ "schema":{ "description":"List of hardwares", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tHardware Name\n\t\t0.0.0.0\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tOperational\n\t\t\n\t\t\t1\n\t\t\tLaptop\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\tHardware notes\n\t\tCode1A\n\t\thardware_cpu\n\t\tprocessor_speed\n\t\t1024\n\t\tMB\n\t\tdomain description\n\t\tWindows 10\n\t\tWorkgroup of the OS\n\t\t
Site 1, Building 1, Department 1
\n\t\t0.000\n\t\t0.000\n\t\t1\n\t\thardware tag\n\t\t1\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createHardware", "description":"Create new hardware", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Hardware fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "technical_contact":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "owner":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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 } ] } } } } }, "example":{ "hardware":{ "name":"Hardware Name", "description":"description", "category":{ "name":"Laptop" }, "site_id":1, "department_id":1, "ip_address":"0.0.0.0", "external_ip":"0.0.0.0", "status":{ "name":"Operational" }, "technical_contact":{ "email":"john.doe@email.com" }, "owner":{ "email":"john.doe@email.com" }, "notes":"Hardware notes", "barcode_encoding_format":"Code1A", "cpu":"hardware_cpu", "processor_speed":"processor_speed", "memory":1024, "swap":"MB", "operating_system":"Windows 10", "domain":"domain description", "active_directory":"Workgroup of the OS", "address":"Site 1, Building 1, Department 1", "longitude":"0.000", "latitude":"0.000", "product_number":"1", "custom_fields_values_attributes":[ { "id":10, "custom_field_id":1, "value":"content" }, { "id":100, "custom_field_id":2, "value":"1" } ], "custom_fields_values":{ "custom_fields_value":[ { "name":"Text custom field", "value":"content" }, { "name":"User custom field", "user_value":{ "email":"john.doe@email.com" } } ] }, "bio":{ "manufacturer":"Dell", "ssn":"1", "model":"model description", "version":"1", "bios_date":"2020-01-01 00:00" }, "tag":"tag", "asset_tag":1 } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "technical_contact":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "owner":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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 } ] } } } } }, "example":"\n\tHardware Name\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\t\n\t\tObject Name\n\t\n\t0.0.0.0\n\t0.0.0.0\n\t\n\t\tObject Name\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\tHardware notes\n\tCode1A\n\thardware_cpu\n\t1024\n\tMB\n\tdomain description\n\tWindows 10\n\tWorkgroup of the OS\n\t
Site 1, Building 1, Department 1
\n\t0.000\n\t0.000\n\t1\n\t\n\t\t1\n\t\n\t1\n\t\n\t\tDell\n\t\t1\n\t\tmodel description\n\t\t1\n\t\t2020-01-01 00:00\n\t\n\thardware tag\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } }, "example":{ "hardware":{ "id":1, "name":"Hardware Name", "description":"description", "category":{ "id":1, "name":"Laptop" }, "site":{ "id":"1", "name":"Austin TX, USA", "location":"AUS", "description":"", "time_zone":"" }, "department":{ "id":"1", "name":"Support", "description":"", "default_assignee_id":"1" }, "ip":"0.0.0.0", "external_ip":"0.0.0.0", "status":{ "name":"Operational" }, "technical_contact":{ "email":"john.doe@email.com" }, "owner":{ "email":"john.doe@email.com" }, "notes":"Hardware notes", "barcode_encoding_format":"Code1A", "cpu":"hardware_cpu", "processor_speed":"processor_speed", "memory":1024, "swap":"MB", "operating_system":"Windows 10", "domain":"domain description", "active_directory":"Workgroup of the OS", "address":"Site 1, Building 1, Department 1", "longitude":"0.000", "latitude":"0.000", "product_number":"1", "custom_fields_values":[ { "id":"10", "custom_field_id":"1", "name":"Text custom field", "value":"content", "options":"", "type_name":"Text" }, { "id":"100", "custom_field_id":"2", "name":"User custom field", "value":"1", "options":"", "type_name":"User", "user":{ "group_id":1, "is_user":true, "id":1, "name":"John Doe", "email":"john.doe@email.com" } } ], "bioses":[ { "id":1, "manufacturer":"Dell", "ssn":"1", "model":"model description", "version":"1", "bios_date":"2020-01-01 00:00", "reported_at":"2020-01-01 00:00" } ], "tag":"tag", "asset_tag":"1" } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tHardware Name\n\t0.0.0.0\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\t\n\t\t1\n\t\tLaptop\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\tHardware notes\n\tCode1A\n\thardware_cpu\n\tprocessor_speed\n\t1024\n\tMB\n\tdomain description\n\tWindows 10\n\tWorkgroup of the OS\n\t
Site 1, Building 1, Department 1
\n\t0.000\n\t0.000\n\t1\n\thardware tag\n\t1\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/mobiles/{id}":{ "get":{ "operationId":"getMobileById", "description":"Get mobile device", "tags":[ "Mobile Device" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tApple 1\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\tMobile Device\n\tApple\n\t1\n\ttrue\n\t1\n\t1\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateMobileById", "description":"Update mobile device with specified fields", "tags":[ "Mobile Device" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Mobile device fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "technical_contact":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "technical_contact":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } }, "example":"\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\t\n\t\tObject Name\n\t\n\tMobile Device\n\tApple\n\t1\n\ttrue\n\t1\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tApple 1\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\tMobile Device\n\tApple\n\t1\n\ttrue\n\t1\n\t1\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteMobileById", "description":"Delete mobile device", "tags":[ "Mobile Device" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted mobile's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/mobiles":{ "get":{ "operationId":"getMobiles", "description":"List of mobile devices", "tags":[ "Mobile Device" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "application/xml":{ "schema":{ "description":"List of mobile devices", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tApple 1\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tOperational\n\t\tMobile Device\n\t\tApple\n\t\t1\n\t\ttrue\n\t\t1\n\t\t1\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createMobile", "description":"Create new mobile device", "tags":[ "Mobile Device" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Mobile Device fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "technical_contact":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "technical_contact":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } }, "example":"\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\t\n\t\tObject Name\n\t\n\tMobile Device\n\tApple\n\t1\n\ttrue\n\t1\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tApple 1\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\tMobile Device\n\tApple\n\t1\n\ttrue\n\t1\n\t1\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/other_assets/{id}":{ "get":{ "operationId":"getAssetById", "description":"Get other asset", "tags":[ "Other Asset" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tApple 1\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tAsset Type\n\t\n\t1\n\tApple\n\t1\n\t0.0.0.0\n\t1\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateAssetById", "description":"Update other asset with specified fields", "tags":[ "Other Asset" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Other asset fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ], "example":{ "name":"Printer" } }, "status":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ], "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", "", null ] } ] }, "owner":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ], "example":{ "name":"Printer" } }, "status":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ], "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", "", null ] } ] }, "owner":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } }, "example":"\n\tAsset Name\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\t1\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\tApple\n\t0.0.0.0\n\t1\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tApple 1\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tAsset Type\n\t\n\t1\n\tApple\n\t1\n\t0.0.0.0\n\t1\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteAssetById", "description":"Delete other asset", "tags":[ "Other Asset" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted other_asset's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/other_assets":{ "get":{ "operationId":"getAssets", "description":"List of other assets", "tags":[ "Other Asset" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "application/xml":{ "schema":{ "description":"List of other asset", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tApple 1\n\t\tdescription\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tOperational\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tAsset Type\n\t\t\n\t\t1\n\t\tApple\n\t\t1\n\t\t0.0.0.0\n\t\t1\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createAsset", "description":"Create new asset", "tags":[ "Other Asset" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Other Asset fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ], "example":{ "name":"Printer" } }, "status":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ], "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", "", null ] } ] }, "owner":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ], "example":{ "name":"Printer" } }, "status":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ], "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", "", null ] } ] }, "owner":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "email" ], "properties":{ "email":{ "type":"string", "format":"email", "example":"john.doe@email.com" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } ] } } } } ] } } } } }, "example":"\n\tAsset Name\n\tdescription\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t1\n\t1\n\t1\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\tApple\n\t0.0.0.0\n\t1\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\tjohn.doe@email.com\n\t\n\t\n\t\t1\n\t\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tApple 1\n\tdescription\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\tOperational\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tAsset Type\n\t\n\t1\n\tApple\n\t1\n\t0.0.0.0\n\t1\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/softwares/{id}":{ "get":{ "operationId":"getSoftwareById", "description":"Get software", "tags":[ "Software" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tGoogle Chrome\n\tsoftware tag\n\tGoogle LLC\n\t0.0.0\n\tGoogle softwares\n\t\n\t\t1\n\t\tGoogle\n\t\t
address description
\n\t\tUS\n\t\tTexas\n\t\t1\n\t\t+000000000\n\t\t+000000000\n\t\twww.google.com\n\t\t2020-01-01T00:00:00.000+01:00\n\t\t2020-10-01T00:00:00.000+01:00\n\t\n\t1\n\t2020-01-01T00:00:00.000+01:00\n\t2020-10-01T00:00:00.000+01:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/softwares":{ "get":{ "operationId":"getSoftwares", "description":"List of softwares", "tags":[ "Software" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } }, "application/xml":{ "schema":{ "description":"List of softwares", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tGoogle Chrome\n\t\tsoftware tag\n\t\tGoogle LLC\n\t\t0.0.0\n\t\tGoogle softwares\n\t\t\n\t\t\t1\n\t\t\tGoogle\n\t\t\t
address description
\n\t\t\tUS\n\t\t\tTexas\n\t\t\t1\n\t\t\t+000000000\n\t\t\t+000000000\n\t\t\twww.google.com\n\t\t\t2020-01-01T00:00:00.000+01:00\n\t\t\t2020-10-01T00:00:00.000+01:00\n\t\t\n\t\t1\n\t\t2020-01-01T00:00:00.000+01:00\n\t\t2020-10-01T00:00:00.000+01:00\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } } }, "/printers/{id}":{ "get":{ "operationId":"getPrinterById", "description":"Get printer", "tags":[ "Printer" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "application/xml":{ "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" } } } } } } } } }, "example":"\n\t1\n\tHP Color Printer\n\tDriver description\n\tPort description\n\ttrue\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updatePrinterById", "description":"Update printer with specified fields", "tags":[ "Printer" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Printer fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "address":{ "type":"string", "example":"address description", "description":"Building/Floor/Room" } } } } } }, "application/xml":{ "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", "", null ] } ] }, "address":{ "type":"string", "example":"address description", "description":"Building/Floor/Room" } } } } }, "example":"\n\t1\n\t1\n\t\n\t\tjohn.doe@email.com\n\t\n\t
address description
\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "application/xml":{ "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" } } } } } } } } }, "example":"\n\t1\n\tHP Color Printer\n\tDriver description\n\tPort description\n\ttrue\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/printers":{ "get":{ "operationId":"getPrinters", "description":"List of printers", "tags":[ "Printer" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } } }, "application/xml":{ "schema":{ "description":"List of printers", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tHP Color Printer\n\t\tDriver description\n\t\tPort description\n\t\ttrue\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\t\n\t\t\t1\n\t\t\ttrue\n\t\t\t1\n\t\t\tJohn Doe\n\t\t\tjohn.doe@email.com\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } } }, "/contracts/{id}":{ "get":{ "operationId":"getContractById", "description":"Get contract", "tags":[ "Contract" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tContract Name\n\tSoftware License\n\tApple\n\tContract Note\n\tActive\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t2020-01-01T00:00:00-00:00\n\t2030-01-01T00:00:00-00:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateContractById", "description":"Update contract with specified fields", "tags":[ "Contract" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Contract fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\tSoftware License\n\tApple\n\tContract Name\n\tContract Note\n\tActive\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t\n\t\t1\n\t\n\t1\n\t2020-01-01T00:00:00-00:00\n\t2030-01-01T00:00:00-00:00\n\ttag1, tag2\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tContract Name\n\tSoftware License\n\tApple\n\tContract Note\n\tActive\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t2020-01-01T00:00:00-00:00\n\t2030-01-01T00:00:00-00:00\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteContractById", "description":"Delete contract", "tags":[ "Contract" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted contract's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/contracts":{ "get":{ "operationId":"getContracts", "description":"List of contracts", "tags":[ "Contract" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "application/xml":{ "schema":{ "description":"List of contracts", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tContract Name\n\t\tSoftware License\n\t\tApple\n\t\tContract Note\n\t\tActive\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\t2020-01-01T00:00:00-00:00\n\t\t2030-01-01T00:00:00-00:00\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createContract", "description":"Create new contract", "tags":[ "Contract" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Contract fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } }, "example":"\n\tSoftware License\n\tApple\n\tContract Name\n\tContract Note\n\tActive\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\t\n\t\t1\n\t\n\t1\n\t2020-01-01T00:00:00-00:00\n\t2030-01-01T00:00:00-00:00\n\ttag1, tag2\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tContract Name\n\tSoftware License\n\tApple\n\tContract Note\n\tActive\n\t\n\t\t1\n\t\tAustin TX, USA\n\t\tAUS\n\t\tAUS\n\t\tUTC-6h\n\t\n\t\n\t\t1\n\t\tSupport\n\t\tSupport Department\n\t\t1\n\t\n\t2020-01-01T00:00:00-00:00\n\t2030-01-01T00:00:00-00:00\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/purchase_orders/{id}":{ "get":{ "operationId":"getPurchaseOrderById", "description":"Get purchase order", "tags":[ "Purchase Order" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tPurchase order Name\n\t2025-01-01T00:00:00.000+01:00\n\t2030-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tApproved\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tBilling address\n\tShiping address\n\tPurchase terms\n\tTerms conditions\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updatePurchaseOrderById", "description":"Update purchase order with specified fields", "tags":[ "Purchase Order" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Purchase Order fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } ] } } } } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } ] } } } } }, "example":"\n\tPurchase order Name\n\t1\n\tJan 01, 2025\n\tJan 01, 2030\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\tApproved\n\t\n\t\tjohn.doe@email.com\n\t\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\tObject Name\n\t\n\tBilling address\n\tShiping address\n\tPurchase terms\n\tTerms conditions\n\t\n\t\t1\n\t\n\t1\n\t1\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tPurchase order Name\n\t2025-01-01T00:00:00.000+01:00\n\t2030-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tApproved\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tBilling address\n\tShiping address\n\tPurchase terms\n\tTerms conditions\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deletePurchaseOrderById", "description":"Delete purchase order", "tags":[ "Purchase Order" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted purchase order's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/purchase_orders":{ "get":{ "operationId":"getCPurchaseOrders", "description":"List of purchase orders", "tags":[ "Purchase Order" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } } }, "application/xml":{ "schema":{ "description":"List of purchase orders", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tPurchase order Name\n\t\t2025-01-01T00:00:00.000+01:00\n\t\t2030-01-01T00:00:00.000+01:00\n\t\t\n\t\t\t1\n\t\t\tObject Name\n\t\t\t/objects/1\n\t\t\n\t\t\n\t\t\t1\n\t\t\tObject Name\n\t\t\t/objects/1\n\t\t\n\t\t\n\t\t\t1\n\t\t\tObject Name\n\t\t\t/objects/1\n\t\t\n\t\tApproved\n\t\t\n\t\t\t1\n\t\t\tObject Name\n\t\t\t/objects/1\n\t\t\n\t\tMonthly\n\t\t1\n\t\tUSD\n\t\tPurchase notes\n\t\t\n\t\t\t1\n\t\t\tObject Name\n\t\t\t/objects/1\n\t\t\n\t\tBilling address\n\t\tShiping address\n\t\tPurchase terms\n\t\tTerms conditions\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createPurchaseOrder", "description":"Create new purchase order", "tags":[ "Purchase Order" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Purchase order fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } ] } } } } } }, "application/xml":{ "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", "", null ] } ] }, "department":{ "type":"object", "oneOf":[ { "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"Object Name" } } }, { "enum":[ "nil", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] }, "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", "", null ] } ] } } } }, { "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", "", null ] } ] } } } ] } } }, "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" } } } } ] } } } } }, "example":"\n\tPurchase order Name\n\t1\n\tJan 01, 2025\n\tJan 01, 2030\n\t\n\t\tObject Name\n\t\n\t\n\t\tObject Name\n\t\n\tApproved\n\t\n\t\tjohn.doe@email.com\n\t\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\tObject Name\n\t\n\tBilling address\n\tShiping address\n\tPurchase terms\n\tTerms conditions\n\t\n\t\t1\n\t\n\t1\n\t1\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "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" } } } } } } } }, "example":"\n\t1\n\tPurchase order Name\n\t2025-01-01T00:00:00.000+01:00\n\t2030-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tApproved\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\t1\n\t\tObject Name\n\t\t/objects/1\n\t\n\tBilling address\n\tShiping address\n\tPurchase terms\n\tTerms conditions\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/vendors/{id}":{ "get":{ "operationId":"getVendorById", "description":"Get vendor", "tags":[ "Vendor" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSolarWinds\n\t\n\t\t1\n\t\tGeneral Business Vendor\n\t\n\twww.solarwinds.com\n\tSupport\n\tsupport@solarwinds.com\n\t+000000000\n\tNotes\n\t
Address description
\n\tCary\n\tNC\n\tUSA 11111\n\t+000000000\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "put":{ "operationId":"updateVendorById", "description":"Update vendor with specified fields", "tags":[ "Vendor" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Vendor fields to update", "content":{ "application/json":{ "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", "", null ] } ], "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" } } } } } }, "application/xml":{ "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", "", null ] } ], "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" } } } } }, "example":"\n\tSolarWinds\n\t\n\t\tObject Name\n\t\n\twww.solarwinds.com\n\tSupport\n\tsupport@solarwinds.com\n\t+000000000\n\tNotes\n\t
Address description
\n\tCary\n\tNC\n\tUSA 11111\n\t+000000000\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSolarWinds\n\t\n\t\t1\n\t\tGeneral Business Vendor\n\t\n\twww.solarwinds.com\n\tSupport\n\tsupport@solarwinds.com\n\t+000000000\n\tNotes\n\t
Address description
\n\tCary\n\tNC\n\tUSA 11111\n\t+000000000\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteVendorById", "description":"Delete vendor", "tags":[ "Vendor" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Returns the deleted vendor's id", "content":{ "application/json":{ "example":{ "deleted_ids":[ "1" ] } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/vendors":{ "get":{ "operationId":"getVendors", "description":"List of vendors", "tags":[ "Vendor" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } }, "application/xml":{ "schema":{ "description":"List of vendors", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tSolarWinds\n\t\t\n\t\t\t1\n\t\t\tGeneral Business Vendor\n\t\t\n\t\twww.solarwinds.com\n\t\tSupport\n\t\tsupport@solarwinds.com\n\t\t+000000000\n\t\tNotes\n\t\t
Address description
\n\t\tCary\n\t\tNC\n\t\tUSA 11111\n\t\t+000000000\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createVendor", "description":"Create new vendor", "tags":[ "Vendor" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "requestBody":{ "required":true, "description":"Vendor fields to fill", "content":{ "application/json":{ "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", "", null ] } ], "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" } } } } } }, "application/xml":{ "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", "", null ] } ], "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" } } } } }, "example":"\n\tSolarWinds\n\t\n\t\tObject Name\n\t\n\twww.solarwinds.com\n\tSupport\n\tsupport@solarwinds.com\n\t+000000000\n\tNotes\n\t
Address description
\n\tCary\n\tNC\n\tUSA 11111\n\t+000000000\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tSolarWinds\n\t\n\t\t1\n\t\tGeneral Business Vendor\n\t\n\twww.solarwinds.com\n\tSupport\n\tsupport@solarwinds.com\n\t+000000000\n\tNotes\n\t
Address description
\n\tCary\n\tNC\n\tUSA 11111\n\t+000000000\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/contracts/{id}/items":{ "post":{ "operationId":"createItem", "description":"Create new contract's Item", "tags":[ "Contract" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Item fields to fill", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\tItem Name\n\t1\n\t1\n\tItem tag\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tItem Name\n\t1\n\t1\n\tItem tag\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/contracts/{contract_id}/items/{item_id}":{ "put":{ "operationId":"updateItemById", "description":"Update contract's item with specified fields", "tags":[ "Contract" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"contract_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the contract" }, { "name":"item_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the item" } ], "requestBody":{ "required":true, "description":"Contract's Item fields to update", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\tItem Name\n\t1\n\t1\n\tItem tag\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tItem Name\n\t1\n\t1\n\tItem tag\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteitemById", "description":"Delete contract's item", "tags":[ "Contract" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"contract_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the contract" }, { "name":"item_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the item" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted item" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/{object_type}/{id}/tasks":{ "post":{ "operationId":"createTask", "description":"Create new Task", "tags":[ "Task" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" } ], "requestBody":{ "required":true, "description":"Task fields to fill", "content":{ "application/json":{ "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", "", null ] } ] }, "due_at":{ "type":"string", "example":"Jan 01, 2030" }, "is_complete":{ "type":"boolean", "example":false } } } } } }, "application/xml":{ "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", "", null ] } ] }, "due_at":{ "type":"string", "example":"Jan 01, 2030" }, "is_complete":{ "type":"boolean", "example":false } } } } }, "example":"\n\tTask Name\n\t\n\t\tjohn.doe@email.com\n\t\n\tJan 01, 2030\n\ttrue\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } }, "application/xml":{ "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" } } } } } } }, "example":"\n\t1\n\tTask Name\n\t2030-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\tIncident\n\t\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/{object_type}/{id}/tasks/{task_id}":{ "put":{ "operationId":"updateTaskById", "description":"Update task with specified fields", "tags":[ "Task" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" }, { "name":"task_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the task" } ], "requestBody":{ "required":true, "description":"Task fields to update", "content":{ "application/json":{ "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", "", null ] } ] }, "due_at":{ "type":"string", "example":"Jan 01, 2030" }, "is_complete":{ "type":"boolean", "example":false } } } } } }, "application/xml":{ "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", "", null ] } ] }, "due_at":{ "type":"string", "example":"Jan 01, 2030" }, "is_complete":{ "type":"boolean", "example":false } } } } }, "example":"\n\tTask Name\n\t\n\t\tjohn.doe@email.com\n\t\n\tJan 01, 2030\n\ttrue\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } }, "application/xml":{ "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" } } } } } } }, "example":"\n\t1\n\tTask Name\n\t2030-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\ttrue\n\t\t1\n\t\tJohn Doe\n\t\tjohn.doe@email.com\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\tIncident\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteTaskById", "description":"Delete task", "tags":[ "Task" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" }, { "name":"task_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the task" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted task" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/{object_type}/{id}/comments":{ "post":{ "operationId":"createComment", "description":"Create new Comment", "tags":[ "Comment" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" } ], "requestBody":{ "required":true, "description":"Comment fields to fill", "content":{ "application/json":{ "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 } ] } } } } } }, "application/xml":{ "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 } ] } } } } }, "example":"\n\tComment body\n\ttrue\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tComment body\n\ttrue\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t1\n\tIncident\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/{object_type}/{id}/comments/{comment_id}":{ "put":{ "operationId":"updateCommentById", "description":"Update comment with specified fields", "tags":[ "Comment" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" }, { "name":"comment_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the comment" } ], "requestBody":{ "required":true, "description":"Comment fields to update", "content":{ "application/json":{ "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 } ] } } } } } }, "application/xml":{ "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 } ] } } } } }, "example":"\n\tComment body\n\ttrue\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\t1\n\tComment body\n\ttrue\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t1\n\tIncident\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteCommentById", "description":"Delete comment", "tags":[ "Comment" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" }, { "name":"comment_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the comment" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted comment" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/hardwares/{id}/warranties":{ "get":{ "operationId":"getWarranties", "description":"List of warranties", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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 } } } } } } }, "application/xml":{ "schema":{ "description":"List of warranties", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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 } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tWarranty service description\n\t\tSolarWinds\n\t\t2020-01-01T00:00:00.000+01:00\n\t\t2030-01-01T00:00:00.000+01:00\n\t\tActive\n\t\ttrue\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createWarranty", "description":"Create new Warranty", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "requestBody":{ "required":true, "description":"Warranty fields to fill", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\tWarranty service description\n\tSolarWinds\n\tJan 01, 2020\n\tJan 01, 2030\n\tActive\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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 } } } } } }, "application/xml":{ "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 } } } } }, "example":"\n\t1\n\tWarranty service description\n\tSolarWinds\n\t2020-01-01T00:00:00.000+01:00\n\t2030-01-01T00:00:00.000+01:00\n\tActive\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/hardwares/{hardware_id}/warranties/{warranty_id}":{ "put":{ "operationId":"updateWarrantyById", "description":"Update warranty with specified fields", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"hardware_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the hardware" }, { "name":"warranty_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the warranty" } ], "requestBody":{ "required":true, "description":"Warranty fields to update", "content":{ "application/json":{ "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" } } } } } }, "application/xml":{ "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" } } } } }, "example":"\n\tWarranty service description\n\tSolarWinds\n\tJan 01, 2020\n\tJan 01, 2030\n\tActive\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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 } } } } } }, "application/xml":{ "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 } } } } }, "example":"\n\t1\n\tWarranty service description\n\tSolarWinds\n\t2020-01-01T00:00:00.000+01:00\n\t2030-01-01T00:00:00.000+01:00\n\tActive\n\ttrue\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteWarrantyById", "description":"Delete warranty", "tags":[ "Hardware" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"hardware_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the hardware" }, { "name":"warranty_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the warranty" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted warranty" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/{object_type}/{id}/time_tracks":{ "get":{ "operationId":"getTimeTracks", "description":"List of time tracks", "tags":[ "Time Track" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } } } }, "application/xml":{ "schema":{ "description":"List of time tracks", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tTime Track Name\n\t\t120\n\t\t2025-01-01T00:00:00.000+01:00\n\t\t2025-01-01T00:00:00.000+01:00\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\tIncident\n\t\t\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } }, "post":{ "operationId":"createTimeTrack", "description":"Create new time track", "tags":[ "Time Track" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" } ], "requestBody":{ "required":true, "description":"Time track fields to fill", "content":{ "application/json":{ "schema":{ "type":"object", "xml":{ "name":"/" }, "properties":{ "time_track":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"Time Track Name" }, "minutes_parsed":{ "type":"string", "example":"2h" } } } } } }, "application/xml":{ "schema":{ "type":"object", "xml":{ "name":"/" }, "properties":{ "time_track":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"Time Track Name" }, "minutes_parsed":{ "type":"string", "example":"2h" } } } } }, "example":"\n\tTime Track Name\n\t2h\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } }, "application/xml":{ "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" } } } } } } }, "example":"\n\t1\n\tTime Track Name\n\t120\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\tIncident\n\t\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/{object_type}/{id}/time_tracks/{time_track_id}":{ "put":{ "operationId":"updateTimeTrackyById", "description":"Update time track with specified fields", "tags":[ "Time Track" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" }, { "name":"time_track_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the time track" } ], "requestBody":{ "required":true, "description":"Time track fields to update", "content":{ "application/json":{ "schema":{ "type":"object", "xml":{ "name":"/" }, "properties":{ "time_track":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"Time Track Name" }, "minutes_parsed":{ "type":"string", "example":"2h" } } } } } }, "application/xml":{ "schema":{ "type":"object", "xml":{ "name":"/" }, "properties":{ "time_track":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"Time Track Name" }, "minutes_parsed":{ "type":"string", "example":"2h" } } } } }, "example":"\n\tTime Track Name\n\t2h\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } }, "application/xml":{ "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" } } } } } } }, "example":"\n\t1\n\tTime Track Name\n\t120\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T00:00:00.000+01:00\n\t\n\t\t1\n\t\t1\n\t\t1\n\t\tjohn.doe@email.com\n\t\tJohn Doe\n\t\ttrue\n\t\t\n\t\t\tinitials\n\t\t\t#1000\n\t\t\tJD\n\t\t\n\t\n\t\n\t\t1\n\t\tIncident\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deleteTimeTrackyById", "description":"Delete time track", "tags":[ "Time Track" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" }, { "name":"time_track_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the time track" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted time track" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/{object_type}/{id}/purchases":{ "post":{ "operationId":"createPurchase", "description":"Create new purchase", "tags":[ "Purchase" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"contracts" } ], "requestBody":{ "required":true, "description":"Purchase fields to fill", "content":{ "application/json":{ "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", "", null ] } ] } } } } } }, "application/xml":{ "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", "", null ] } ] } } } } }, "example":"\n\t1\n\tJan 01, 2025\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\tObject Name\n\t\n" } } }, "responses":{ "200":{ "description":"Object created and returned correctly", "content":{ "application/json":{ "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" } } } } } } } }, "application/xml":{ "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" } } } } } } }, "example":"\n\t1\n\t1\n\tJan 01, 2025\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\t1\n\t\tGoogle\n\t\t
address description
\n\t\tUS\n\t\tTexas\n\t\t1\n\t\t+000000000\n\t\t+000000000\n\t\twww.google.com\n\t\t2020-01-01T00:00:00.000+01:00\n\t\t2020-10-01T00:00:00.000+01:00\n\t\n" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/{object_type}/{id}/purchases/{purchase_id}":{ "put":{ "operationId":"updatePurchaseById", "description":"Update purchase with specified fields", "tags":[ "Purchase" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"contracts / other_assets" }, { "name":"purchase_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the purchase" } ], "requestBody":{ "required":true, "description":"Purchase fields to update", "content":{ "application/json":{ "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", "", null ] } ] } } } } } }, "application/xml":{ "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", "", null ] } ] } } } } }, "example":"\n\t1\n\tJan 01, 2025\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\tObject Name\n\t\n" } } }, "responses":{ "200":{ "description":"Object was updated correctly", "content":{ "application/json":{ "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" } } } } } } } }, "application/xml":{ "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" } } } } } } }, "example":"\n\t1\n\t1\n\tJan 01, 2025\n\tMonthly\n\t1\n\tUSD\n\tPurchase notes\n\t\n\t\t1\n\t\tGoogle\n\t\t
address description
\n\t\tUS\n\t\tTexas\n\t\t1\n\t\t+000000000\n\t\t+000000000\n\t\twww.google.com\n\t\t2020-01-01T00:00:00.000+01:00\n\t\t2020-10-01T00:00:00.000+01:00\n\t\n" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } }, "delete":{ "operationId":"deletePurchaseById", "description":"Delete purchase", "tags":[ "Purchase" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"contracts" }, { "name":"purchase_id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the purchase" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted purchase" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/memberships":{ "post":{ "operationId":"createMembership", "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", "tags":[ "Membership" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"group_id", "in":"query", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the group" }, { "name":"user_ids", "in":"query", "schema":{ "type":"string" }, "required":true, "description":"Numeric IDs of the users" } ], "responses":{ "200":{ "description":"membership created and returned correctly" }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/memberships/{id}":{ "delete":{ "operationId":"deleteMemebershipById", "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", "tags":[ "Membership" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" } ], "responses":{ "200":{ "description":"Message regarding a successful operation", "content":{ "application/json":{ "example":{ "messages":{ "message":"Deleted membership" } } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/audits":{ "get":{ "operationId":"getAudits", "description":"List of audits", "tags":[ "Audit" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } }, "application/xml":{ "schema":{ "description":"List of audits", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tState changed from New to On Hold\n\t\tUpdate\n\t\t2025-01-01T00:00:00.000+01:00\n\t\tIncident\n\t\t1\n\t\t1\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tAudit note\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } } } }, "/{object_type}/{id}/audits":{ "get":{ "operationId":"getAuditById", "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\"", "tags":[ "Audit" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" }, { "name":"id", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Numeric ID of the object to get or update" }, { "name":"object_type", "in":"path", "schema":{ "type":"string" }, "required":true, "description":"Source object type", "example":"incidents" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } } } }, "application/xml":{ "schema":{ "description":"List of audits of a specific object", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } } } }, "example":"<>\n\t\n\t\t1\n\t\tState changed from New to On Hold\n\t\tUpdate\n\t\t2025-01-01T00:00:00.000+01:00\n\t\tIncident\n\t\t1\n\t\t1\n\t\t\n\t\t\t1\n\t\t\t1\n\t\t\t1\n\t\t\tjohn.doe@email.com\n\t\t\tJohn Doe\n\t\t\ttrue\n\t\t\t\n\t\t\t\tinitials\n\t\t\t\t#1000\n\t\t\t\tJD\n\t\t\t\n\t\t\n\t\t\n\t\t\t1\n\t\t\tAustin TX, USA\n\t\t\tAUS\n\t\t\tAUS\n\t\t\tUTC-6h\n\t\t\n\t\t\n\t\t\t1\n\t\t\tSupport\n\t\t\tSupport Department\n\t\t\t1\n\t\t\n\t\tAudit note\n\t\n\n<>" } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Internal Server Error" } } } }, "/risks":{ "get":{ "operationId":"getRisks", "description":"List of risks", "tags":[ "Risk" ], "parameters":[ { "name":"X-Samanage-Authorization", "in":"header", "schema":{ "type":"string" }, "example":"Bearer TOKEN" } ], "responses":{ "200":{ "description":"Object was returned correctly", "content":{ "application/json":{ "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" } } } } }, "application/xml":{ "schema":{ "description":"List of risks", "type":"array", "xml":{ "name":"/", "wrapped":true }, "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" } } } }, "example":"<>\n\t1\n\tRisk name\n\tMedium\n\tInventory\n\ttrue\n\ttrue\n\t\n\t\t1\n\t\tComputer name\n\t\tHardware\n\t\n\t2025-01-01T00:00:00.000+01:00\n\t2025-01-01T00:00:00.000+01:00\n\n<>" } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } }, "/attachments":{ "post":{ "operationId":"createAttachment", "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

", "tags":[ "Attachment" ], "responses":{ "200":{ "description":"File successfully attached" }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } } } } }, "tags":[ { "name":"Incident", "description":"Incident operations" }, { "name":"Problem", "description":"Problem operations" }, { "name":"Change", "description":"Change operations" }, { "name":"Change Catalog", "description":"Change catalog operations" }, { "name":"Release", "description":"Release operations" }, { "name":"Solution", "description":"Solution operations" }, { "name":"Catalog Item", "description":"Catalog Item operations" }, { "name":"Service Request", "description":"Requesting a service" }, { "name":"Configuration Item", "description":"Configuration Item operations" }, { "name":"User", "description":"User operations" }, { "name":"Site", "description":"Site operations" }, { "name":"Department", "description":"Department operations" }, { "name":"Role", "description":"Role operations" }, { "name":"Group", "description":"Group operations" }, { "name":"Membership", "description":"Membership operations" }, { "name":"Category", "description":"Category operations" }, { "name":"Hardware", "description":"Hardware operations" }, { "name":"Mobile Device", "description":"Mobile device operations" }, { "name":"Other Asset", "description":"Other asset operations" }, { "name":"Software", "description":"Software operations" }, { "name":"Printer", "description":"Printer operations" }, { "name":"Contract", "description":"Contract operations" }, { "name":"Purchase Order", "description":"Purchase order operations" }, { "name":"Vendor", "description":"Vendor operations" }, { "name":"Task", "description":"Task operations" }, { "name":"Comment", "description":"Comment operations" }, { "name":"Time Track", "description":"Time Track operations" }, { "name":"Purchase", "description":"Purchase operations" }, { "name":"Audit", "description":"Audit operations" }, { "name":"Risk", "description":"Risk operations" }, { "name":"Attachment", "description":"Attachment operations" } ] }