{"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\nFor APJ based customers, please use `https://apiau.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: `<incident> <field_to_update>content</field_to_update> </incident>`\n\nJSON Example: `{\"incident\": {\"field_to_update\": \"content\"}}`\n\nTo clear fields, use the following format:\n\nXML Example: `<incident> <field_to_update></field_to_update> </incident>`\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. For more details click here [Token authentication for API integration](https://documentation.solarwinds.com/en/success_center/swsd/content/completeguidetoswsd/token-authentication-for-api-integration.htm). 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: <div style=\"word-wrap: break-word;\"> AAAZWV0YXkubmF0YW4rNUBzYW1hbmFnZS5jb20hbGciOiJIUzUxMiJ9.eyJ1c2VyX2ljIjoxMjU2OTQzLCJnZW5lcmF0ZWRfYXQiOiIyMDE3LTA2LTA3IDA5OjE3OjI5In0.j_H15qzJJr9vXGAHCThLEOQrE9GGbjMxZJOs5zAf_iqaGqxlIOAmvPpBx0td_C3r7dliAfXXIgdqhZHVoK1KTwAzd1</div>\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## Limitations\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\nAdvanced Plan - 1000 calls per minute\n\nPremier 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## Updates History\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 <url>; rel=”relative”). For example:\n\nX-Per-Page: 50\n\nX-Total-Count: 3099\n\nX-Total-Pages: 62\n\nLink: `<https://api.samanage.com/incidents.xml?page=1>`; rel=\"first\",\n\n`<https://api.samanage.com/incidents.xml?page=8>`; rel=\"prev\",\n\n`<https://api.samanage.com/incidents.xml?page=10>`; rel=\"next\",\n\n`<https://api.samanage.com/incidents.xml?page=62>`; 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`<incident><custom_fields_values>`\n\n`<custom_fields_value><name>field name</name><value>content</value></custom_fields_value>`\n\n`</custom_fields_values></incident>`\n\nJSON Example:\n\n`{\"incident\": {\"custom_fields_values\": {\"custom_fields_value\": [{\"name\": \"field name\",\"value\": \"content\"}]}}}`\n## API filtering\nYou have two options for filtering: by days or by time. You can also use custom ranges for filtering by days.\n\n**Filter by fixed days or time**\n\n* Filter by fixed days\n\n  `{api.samanage.com}/incidents?updated={days} - Last X days` - Options for Last X days: 1-90, or 365 (example: 365)\n\n* Filter by relative times\n\n   `{api.samanage.com}/incidents?updated={hours}h - Last X hours` - Options for hours: 1-23 (example: 7h)\n\n**Filter using a custom range**\n\n* Select the date and time range in ISO 8601 UTC format.\n\n* Filter by updated_from and updated_to.\n\n   &#9675; Updated_from indicates the range start.\n\n   &#9675; Updated_to indicates the range end.\n\n   **Examples:**\n\n  Get incidents updated in a specific date/time range - `incidents.json?updated_from='2023-11-29T08:00'&updated_to='2023-11-30T08:00'`\n\n    Get incidents updated from a specific date/time until now - `incidents.json?updated_from='2023-11-29T08:00'`\n\n    Get incidents created in a specific date/time range - `incidents.json?created_from='2023-11-29T08:00'&created_to='2023-11-30T08:00'`\n\n    Get incidents created from a specific date/time until now - `incidents.json?created_from='2023-11-29T08:00'`\n\n**Filter using a custom date (custom_gte to custom_lte option)** - *Deprecated*\n\n &nbsp; &nbsp; **Examples:**\n\n &nbsp; &nbsp; Get all incidents with an updated or created date greater than or equal to a specific date and less than or equal to a different specific date -\n\n &nbsp; &nbsp; `{api.samanage.com}/incidents?updated=Select Date Range&updated_custom_gte={Date/Datetime}&updated_custom_lte={Date/datetime}`<br><br><hr></hr>","version":"0.2.20","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"},{"url":"https://apiau.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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the incidents","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as comments, attachments, service statistics, and more","value":{"":"layout=long"}}}}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}},"examples":{"layout=short":{"value":{"id":10000,"number":1000,"name":"Incident Name","description":"<p>description</p>","description_no_html":"description","state":"New","priority":"High","category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"assignee":{"group_id":1,"is_user":"true","id":1,"name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"requester":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"created_at":"2024-01-01T00:00:00.000+01:00","updated_at":"2024-01-01T00:00:00.000+01:00","due_at":"2025-01-01T00:00:00.000+01:00","sla_violations":[{"id":1000,"name":"SLA0001","sla_id":289,"sla_type":"not_commented","resolved":false,"time_delay":1,"time_units":"minutes","assignee":{"id":1,"name":"John Doe"},"group_assignee":{"id":1,"name":"Network Team"}}],"number_of_comments":0,"user_saw_all_comments":true,"is_service_request":false,"created_by":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"resolved_by":{"id":1,"name":"John Doe","disabled":false,"title":"title","email":"john.doe@email.com","created_at":"2023-01-01T00:00:00.000-00:00","updated_at":"2023-01-01T00:00:00.000-00:00","last_login":"2023-01-01T00:00:00.000-00:00","phone":"0123-456-789","mobile_phone":"0987-654-321","role":{"id":1,"name":"Administrator","description":"description","portal":false,"show_my_tasks":false},"group_ids":[1],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"provider","custom_fields_values":[],"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{}},"resolution_description":"description","resolution_code":"Done","customer_satisfaction_survey_sent_at":"2020-01-01T00:00:00.000-00:00","customer_satisfaction_survey_completed_at":"2020-01-01T00:00:00.000-00:00","custom":"2020-01-01 00:00:00.000","href":"http://mydomain.com/incidents/100","href_account_domain":"http://mydomain.com/incidents/100","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"cc":["jane.doe@email.com"],"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"}}],"origin":"api","price":"1234.00 USD","releases":[{"id":100,"href":"https://mydomain.com/releases/100"}],"problems":[{"id":100,"href":"https://mydomain.com/problems/100"}],"incidents":[{"id":100,"href":"https://mydomain.com/incidents/100"}],"changes":[{"id":100,"href":"https://mydomain.com/changes/100"}],"tasks":[{"id":100,"href":"https://mydomain.com/incidents/100/tasks/100"}],"time_tracks":[{"id":100,"href":"https://mydomain.com/incidents/100/time_tracks/100"}],"solutions":[{"id":100,"href":"https://mydomain.com/solutions/100"}],"assets":[{"id":100,"href":"https://mydomain.com/hardwares/100"}],"mobiles":[{"id":100,"href":"https://mydomain.com/mobiles/100"}],"other_assets":[{"id":100,"href":"https://mydomain.com/other_assets/100"}],"configuration_items":[{"id":100,"href":"https://mydomain.com/configuration_items/100"}],"discovery_hardware":[{"id":100,"href":"https://mydomain.com/descovery_hardwares/100"}],"purchase_orders":[{"id":100,"href":"https://mydomain.com/purchase_orders/100"}]}},"layout=long":{"value":{"id":10000,"number":1000,"name":"Incident Name","description":"<p>description</p>","description_no_html":"description","state":"New","priority":"High","category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"assignee":{"group_id":1,"is_user":"true","id":1,"name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"requester":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"created_at":"2024-01-01T00:00:00.000+01:00","updated_at":"2024-01-01T00:00:00.000+01:00","due_at":"2025-01-01T00:00:00.000+01:00","sla_violations":[{"id":1000,"name":"SLA0001","sla_id":289,"sla_type":"not_commented","resolved":false,"time_delay":1,"time_units":"minutes","assignee":{"id":1,"name":"John Doe"},"group_assignee":{"id":1,"name":"Network team"}}],"number_of_comments":0,"user_saw_all_comments":true,"is_service_request":false,"created_by":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"resolved_by":{"id":1,"name":"John Doe","disabled":false,"title":"title","email":"john.doe@email.com","created_at":"2023-01-01T00:00:00.000-00:00","updated_at":"2023-01-01T00:00:00.000-00:00","last_login":"2023-01-01T00:00:00.000-00:00","phone":"0123-456-789","mobile_phone":"0987-654-321","role":{"id":1,"name":"Administrator","description":"description","portal":false,"show_my_tasks":false},"group_ids":[1],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"provider","custom_fields_values":[],"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{}},"resolution_description":"description","resolution_code":"Done","customer_satisfaction_survey_sent_at":"2020-01-01T00:00:00.000-00:00","customer_satisfaction_survey_completed_at":"2020-01-01T00:00:00.000-00:00","custom":"2020-01-01 00:00:00.000","href":"http://mydomain.com/incidents/100","href_account_domain":"http://mydomain.com/incidents/100","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"cc":["jane.doe@email.com"],"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"}}],"origin":"api","price":"1234.00 USD","releases":[{"id":100,"href":"https://mydomain.com/releases/100"}],"problems":[{"id":100,"href":"https://mydomain.com/problems/100"}],"incidents":[{"id":100,"href":"https://mydomain.com/incidents/100"}],"changes":[{"id":100,"href":"https://mydomain.com/changes/100"}],"tasks":[{"id":100,"href":"https://mydomain.com/incidents/100/tasks/100"}],"time_tracks":[{"id":100,"href":"https://mydomain.com/incidents/100/time_tracks/100"}],"solutions":[{"id":100,"href":"https://mydomain.com/solutions/100"}],"assets":[{"id":100,"href":"https://mydomain.com/hardwares/100"}],"mobiles":[{"id":100,"href":"https://mydomain.com/mobiles/100"}],"other_assets":[{"id":100,"href":"https://mydomain.com/other_assets/100"}],"configuration_items":[{"id":100,"href":"https://mydomain.com/configuration_items/100"}],"discovery_hardware":[{"id":100,"href":"https://mydomain.com/descovery_hardwares/100"}],"purchase_orders":[{"id":100,"href":"https://mydomain.com/purchase_orders/100"}],"comments":[{"id":10,"body":"everybody","user":{"id":4713,"name":"Simmy","email":"simmy.dian@mydomain.com","avatar":{"type":"image","image_class":"gravatar_image","sso_image_class":"","avatar_url":"https://secure.gravatar.com/avatar/8f6284"}},"created_at":"2024-08-18T22:40:42.000-07:00","updated_at":"2024-08-18T22:40:42.000-07:00","attachments":[],"inline_attachments":[],"shared_attachments":[],"is_private":false,"seen_by":[8610546],"isTask":false,"task_info":{},"requester":null,"commenter_id":139207697,"commenter_type":"Incident","origin":0}],"attachments":[],"statistics":[{"statistic_type":"State Changed","time":"00:01","time_elapsed":"00:01","business_time_elapsed":"00:00","value":"2024-08-20 07:59:20 UTC"},{"statistic_type":"sla_state_changed","time":"00:00","time_elapsed":"00:00","business_time_elapsed":"00:00","value":"2024-08-20 07:58:48 UTC"},{"statistic_type":"to_resolve","time":"00:01","time_elapsed":"00:01","business_time_elapsed":"00:00","value":"2024-08-20 07:59:20 UTC"},{"statistic_type":"to_close","time":"00:02","time_elapsed":"00:02","business_time_elapsed":"00:00","value":"2024-08-18 13:41:58 UTC"}],"tags":[{"name":"emr"}],"associated_sla_names":["not_resolved"],"is_customer_satisfied":"Yes","customer_satisfaction_response":"optimistic, aren't we?","total_time_spent":0,"resolution":null,"resolution_type":"Done"}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","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":"<id>1</id>\n<number>1</number>\n<name>Incident Name</name>\n<description>description</description>\n<description_no_html>description</description_no_html>\n<state>New</state>\n<priority>High</priority>\n<category>\n\t<id>1</id>\n\t<name>Category / Subcategory name</name>\n\t<default_tags>tag1, tag2</default_tags>\n\t<parent_id>1</parent_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<deleted>true</deleted>\n</category>\n<subcategory>\n\t<id>1</id>\n\t<name>Category / Subcategory name</name>\n\t<default_tags>tag1, tag2</default_tags>\n\t<parent_id>1</parent_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<deleted>true</deleted>\n</subcategory>\n<assignee>\n\t<group_id>1</group_id>\n\t<is_user>true</is_user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<email>john.doe@email.com</email>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</assignee>\n<group_assignee>\n\t<group_id>1</group_id>\n\t<is_user>false</is_user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<description>John Doe</description>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</group_assignee>\n<requester>\n\t<id>1</id>\n\t<account_id>1</account_id>\n\t<user_id>1</user_id>\n\t<email>john.doe@email.com</email>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</requester>\n<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n<due_at>2020-01-01T00:00:00.000+00:00</due_at>\n<number_of_comments>0</number_of_comments>\n<user_saw_all_comments>true</user_saw_all_comments>\n<is_service_request>true</is_service_request>\n<created_by>\n\t<id>1</id>\n\t<account_id>1</account_id>\n\t<user_id>1</user_id>\n\t<email>john.doe@email.com</email>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</created_by>\n<resolved_by>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<title>title</title>\n\t<email>john.doe@email.com</email>\n\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n\t<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n\t<last_login>2020-01-01T00:00:00.000+00:00</last_login>\n\t<phone>0123-456-789</phone>\n\t<mobile_phone>0123-456-789</mobile_phone>\n\t<role>\n\t\t<id>1</id>\n\t\t<name>Requester</name>\n\t\t<description>Requester role</description>\n\t\t<portal>true</portal>\n\t\t<show_my_tasks>true</show_my_tasks>\n\t</role>\n\t<available_for_assignment>true</available_for_assignment>\n\t<can_be_available_for_assignment>true</can_be_available_for_assignment>\n\t<provider>provider</provider>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n</resolved_by>\n<resolution_description>description</resolution_description>\n<resolution_code>Done</resolution_code>\n<customer_satisfaction_survey_sent_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_sent_at>\n<customer_satisfaction_survey_completed_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_completed_at>\n<custom>2023-01-01 00:00:00.000</custom>\n<href>https://mydomain.com/object_type/1</href>\n<href_account_domain>https://mydomain.com/object_type/1</href_account_domain>\n<site>\n\t<id>1</id>\n\t<name>Austin TX, USA</name>\n\t<description>AUS</description>\n\t<location>AUS</location>\n\t<timezone>UTC-6h</timezone>\n</site>\n<department>\n\t<id>1</id>\n\t<name>Support</name>\n\t<description>Support Department</description>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n</department>\n<origin>api</origin>\n<price>1234.00 USD</price>"}}},"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","description":"The name property accepts a maximum of 255 chars. values exceeding this limit will be truncated with ellipsis"},"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","nullable":true,"example":"string"},"state_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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":{"description":"Incident can have only one Problem associated","anyOf":[{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"array","maxItems":1,"items":{"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"group_assignee":{"name":"Network Team"},"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}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}],"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","description":"The name property accepts a maximum of 255 chars. values exceeding this limit will be truncated with ellipsis"},"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","nullable":true,"example":"string"},"state_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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":{"description":"Incident can have only one Problem associated","anyOf":[{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"array","maxItems":1,"items":{"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":"<incident>\n\t<name>Incident Name</name>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<description>string</description>\n\t<state_id>1</state_id>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<assignee_id>1</assignee_id>\n\t<group_assignee_id>1</group_assignee_id>\n\t<priority>1</priority>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<category>\n\t\t<name>Object Name</name>\n\t</category>\n\t<subcategory>\n\t\t<name>Object Name</name>\n\t</subcategory>\n\t<due_at>Jan 01,2025</due_at>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<incidents>1</incidents>\n\t<solutions>1</solutions>\n\t<changes>1</changes>\n\t<problems>1</problems>\n\t<releases>1</releases>\n</incident>"}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","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":{"id":10000,"number":1000,"name":"Incident Name","description":"<p>description</p>","description_no_html":"description","state":"New","priority":"High","category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"assignee":{"group_id":1,"is_user":"true","id":1,"name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"requester":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"created_at":"2024-01-01T00:00:00.000+01:00","updated_at":"2024-01-01T00:00:00.000+01:00","due_at":"2025-01-01T00:00:00.000+01:00","sla_violations":[{"id":1000,"name":"SLA0001","sla_id":289,"sla_type":"not_commented","resolved":false,"time_delay":1,"time_units":"minutes","assignee":{"id":1,"name":"John Doe"},"group_assignee":{"id":1,"name":"Network Team"}}],"number_of_comments":0,"user_saw_all_comments":true,"is_service_request":false,"created_by":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"resolved_by":{"id":1,"name":"John Doe","disabled":false,"title":"title","email":"john.doe@email.com","created_at":"2023-01-01T00:00:00.000-00:00","updated_at":"2023-01-01T00:00:00.000-00:00","last_login":"2023-01-01T00:00:00.000-00:00","phone":"0123-456-789","mobile_phone":"0987-654-321","role":{"id":1,"name":"Administrator","description":"description","portal":false,"show_my_tasks":false},"group_ids":[1],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"provider","custom_fields_values":[],"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{}},"resolution_description":"description","resolution_code":"Done","customer_satisfaction_survey_sent_at":"2020-01-01T00:00:00.000-00:00","customer_satisfaction_survey_completed_at":"2020-01-01T00:00:00.000-00:00","custom":"2020-01-01 00:00:00.000","href":"http://mydomain.com/incidents/100","href_account_domain":"http://mydomain.com/incidents/100","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"cc":["jane.doe@email.com"],"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"}}],"origin":"api","price":"1234.00 USD","releases":[{"id":100,"href":"https://mydomain.com/releases/100"}],"problems":[{"id":100,"href":"https://mydomain.com/problems/100"}],"incidents":[{"id":100,"href":"https://mydomain.com/incidents/100"}],"changes":[{"id":100,"href":"https://mydomain.com/changes/100"}],"tasks":[{"id":100,"href":"https://mydomain.com/incidents/100/tasks/100"}],"time_tracks":[{"id":100,"href":"https://mydomain.com/incidents/100/time_tracks/100"}],"solutions":[{"id":100,"href":"https://mydomain.com/solutions/100"}],"assets":[{"id":100,"href":"https://mydomain.com/hardwares/100"}],"mobiles":[{"id":100,"href":"https://mydomain.com/mobiles/100"}],"other_assets":[{"id":100,"href":"https://mydomain.com/other_assets/100"}],"configuration_items":[{"id":100,"href":"https://mydomain.com/configuration_items/100"}],"discovery_hardware":[{"id":100,"href":"https://mydomain.com/descovery_hardwares/100"}],"purchase_orders":[{"id":100,"href":"https://mydomain.com/purchase_orders/100"}]}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","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":"<id>1</id>\n<number>1</number>\n<name>Incident Name</name>\n<description>description</description>\n<description_no_html>description</description_no_html>\n<state>New</state>\n<priority>High</priority>\n<category>\n\t<id>1</id>\n\t<name>Category / Subcategory name</name>\n\t<default_tags>tag1, tag2</default_tags>\n\t<parent_id>1</parent_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<deleted>true</deleted>\n</category>\n<subcategory>\n\t<id>1</id>\n\t<name>Category / Subcategory name</name>\n\t<default_tags>tag1, tag2</default_tags>\n\t<parent_id>1</parent_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<deleted>true</deleted>\n</subcategory>\n<assignee>\n\t<group_id>1</group_id>\n\t<is_user>true</is_user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<email>john.doe@email.com</email>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</assignee>\n<group_assignee>\n\t<group_id>1</group_id>\n\t<is_user>false</is_user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<description>John Doe</description>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</group_assignee>\n<requester>\n\t<id>1</id>\n\t<account_id>1</account_id>\n\t<user_id>1</user_id>\n\t<email>john.doe@email.com</email>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</requester>\n<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n<due_at>2020-01-01T00:00:00.000+00:00</due_at>\n<number_of_comments>0</number_of_comments>\n<user_saw_all_comments>true</user_saw_all_comments>\n<is_service_request>true</is_service_request>\n<created_by>\n\t<id>1</id>\n\t<account_id>1</account_id>\n\t<user_id>1</user_id>\n\t<email>john.doe@email.com</email>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</created_by>\n<resolved_by>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<title>title</title>\n\t<email>john.doe@email.com</email>\n\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n\t<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n\t<last_login>2020-01-01T00:00:00.000+00:00</last_login>\n\t<phone>0123-456-789</phone>\n\t<mobile_phone>0123-456-789</mobile_phone>\n\t<role>\n\t\t<id>1</id>\n\t\t<name>Requester</name>\n\t\t<description>Requester role</description>\n\t\t<portal>true</portal>\n\t\t<show_my_tasks>true</show_my_tasks>\n\t</role>\n\t<available_for_assignment>true</available_for_assignment>\n\t<can_be_available_for_assignment>true</can_be_available_for_assignment>\n\t<provider>provider</provider>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n</resolved_by>\n<resolution_description>description</resolution_description>\n<resolution_code>Done</resolution_code>\n<customer_satisfaction_survey_sent_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_sent_at>\n<customer_satisfaction_survey_completed_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_completed_at>\n<custom>2023-01-01 00:00:00.000</custom>\n<href>https://mydomain.com/object_type/1</href>\n<href_account_domain>https://mydomain.com/object_type/1</href_account_domain>\n<site>\n\t<id>1</id>\n\t<name>Austin TX, USA</name>\n\t<description>AUS</description>\n\t<location>AUS</location>\n\t<timezone>UTC-6h</timezone>\n</site>\n<department>\n\t<id>1</id>\n\t<name>Support</name>\n\t<description>Support Department</description>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n</department>\n<origin>api</origin>\n<price>1234.00 USD</price>"}}},"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"},{"name":"Updated_at filter","in":"query","schema":{"type":"string"},"required":false,"description":"Filter by updated_at property, you can choose between select date range or last X days","examples":{"example1":{"summary":"Select date range - Date format: Short month Day Year (e.g. Mar 2 2023)","value":{"":"{DOMAIN_NAME}/incidents?updated=Select Date Range&updated_custom_gte={Date}&updated_custom_lte={Date}"}},"example2":{"summary":"Last X days - Options: 1, 7, 14, 30, 60, or 90","value":{"":"{DOMAIN_NAME}/incidents?updated={Days}"}}}},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the incidents","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as comments, attachments, service statistics, and more","value":{"":"layout=long"}}}}],"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":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}},"examples":{"layout=short":{"value":[{"id":10000,"number":1000,"name":"Incident Name","description":"<p>description</p>","description_no_html":"description","state":"New","priority":"High","category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"assignee":{"group_id":1,"is_user":"true","id":1,"name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"requester":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"created_at":"2024-01-01T00:00:00.000+01:00","updated_at":"2024-01-01T00:00:00.000+01:00","due_at":"2025-01-01T00:00:00.000+01:00","sla_violations":[{"id":1000,"name":"SLA0001","sla_id":289,"sla_type":"not_commented","resolved":false,"time_delay":1,"time_units":"minutes","assignee":{"id":1,"name":"John Doe"},"group_assignee":{"id":1,"name":"Network Team"}}],"number_of_comments":0,"user_saw_all_comments":true,"is_service_request":false,"created_by":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"resolved_by":{"id":1,"name":"John Doe","disabled":false,"title":"title","email":"john.doe@email.com","created_at":"2023-01-01T00:00:00.000-00:00","updated_at":"2023-01-01T00:00:00.000-00:00","last_login":"2023-01-01T00:00:00.000-00:00","phone":"0123-456-789","mobile_phone":"0987-654-321","role":{"id":1,"name":"Administrator","description":"description","portal":false,"show_my_tasks":false},"group_ids":[1],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"provider","custom_fields_values":[],"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{}},"resolution_description":"description","resolution_code":"Done","customer_satisfaction_survey_sent_at":"2020-01-01T00:00:00.000-00:00","customer_satisfaction_survey_completed_at":"2020-01-01T00:00:00.000-00:00","custom":"2020-01-01 00:00:00.000","href":"http://mydomain.com/incidents/100","href_account_domain":"http://mydomain.com/incidents/100","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"cc":["jane.doe@email.com"],"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"}}],"origin":"api","price":"1234.00 USD","releases":[{"id":100,"href":"https://mydomain.com/releases/100"}],"problems":[{"id":100,"href":"https://mydomain.com/problems/100"}],"incidents":[{"id":100,"href":"https://mydomain.com/incidents/100"}],"changes":[{"id":100,"href":"https://mydomain.com/changes/100"}],"tasks":[{"id":100,"href":"https://mydomain.com/incidents/100/tasks/100"}],"time_tracks":[{"id":100,"href":"https://mydomain.com/incidents/100/time_tracks/100"}],"solutions":[{"id":100,"href":"https://mydomain.com/solutions/100"}],"assets":[{"id":100,"href":"https://mydomain.com/hardwares/100"}],"mobiles":[{"id":100,"href":"https://mydomain.com/mobiles/100"}],"other_assets":[{"id":100,"href":"https://mydomain.com/other_assets/100"}],"configuration_items":[{"id":100,"href":"https://mydomain.com/configuration_items/100"}],"discovery_hardware":[{"id":100,"href":"https://mydomain.com/descovery_hardwares/100"}],"purchase_orders":[{"id":100,"href":"https://mydomain.com/purchase_orders/100"}]}]},"layout=long":{"value":[{"id":10000,"number":1000,"name":"Incident Name","description":"<p>description</p>","description_no_html":"description","state":"New","priority":"High","category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"assignee":{"group_id":1,"is_user":"true","id":1,"name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"requester":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"created_at":"2024-01-01T00:00:00.000+01:00","updated_at":"2024-01-01T00:00:00.000+01:00","due_at":"2025-01-01T00:00:00.000+01:00","sla_violations":[{"id":1000,"name":"SLA0001","sla_id":289,"sla_type":"not_commented","resolved":false,"time_delay":1,"time_units":"minutes","assignee":{"id":1,"name":"John Doe"},"group_assignee":{"id":1,"name":"Network team"}}],"number_of_comments":0,"user_saw_all_comments":true,"is_service_request":false,"created_by":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"resolved_by":{"id":1,"name":"John Doe","disabled":false,"title":"title","email":"john.doe@email.com","created_at":"2023-01-01T00:00:00.000-00:00","updated_at":"2023-01-01T00:00:00.000-00:00","last_login":"2023-01-01T00:00:00.000-00:00","phone":"0123-456-789","mobile_phone":"0987-654-321","role":{"id":1,"name":"Administrator","description":"description","portal":false,"show_my_tasks":false},"group_ids":[1],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"provider","custom_fields_values":[],"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{}},"resolution_description":"description","resolution_code":"Done","customer_satisfaction_survey_sent_at":"2020-01-01T00:00:00.000-00:00","customer_satisfaction_survey_completed_at":"2020-01-01T00:00:00.000-00:00","custom":"2020-01-01 00:00:00.000","href":"http://mydomain.com/incidents/100","href_account_domain":"http://mydomain.com/incidents/100","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"cc":["jane.doe@email.com"],"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"}}],"origin":"api","price":"1234.00 USD","releases":[{"id":100,"href":"https://mydomain.com/releases/100"}],"problems":[{"id":100,"href":"https://mydomain.com/problems/100"}],"incidents":[{"id":100,"href":"https://mydomain.com/incidents/100"}],"changes":[{"id":100,"href":"https://mydomain.com/changes/100"}],"tasks":[{"id":100,"href":"https://mydomain.com/incidents/100/tasks/100"}],"time_tracks":[{"id":100,"href":"https://mydomain.com/incidents/100/time_tracks/100"}],"solutions":[{"id":100,"href":"https://mydomain.com/solutions/100"}],"assets":[{"id":100,"href":"https://mydomain.com/hardwares/100"}],"mobiles":[{"id":100,"href":"https://mydomain.com/mobiles/100"}],"other_assets":[{"id":100,"href":"https://mydomain.com/other_assets/100"}],"configuration_items":[{"id":100,"href":"https://mydomain.com/configuration_items/100"}],"discovery_hardware":[{"id":100,"href":"https://mydomain.com/descovery_hardwares/100"}],"purchase_orders":[{"id":100,"href":"https://mydomain.com/purchase_orders/100"}],"comments":[{"id":10,"body":"everybody","user":{"id":4713,"name":"Simmy","email":"simmy.dian@mydomain.com","avatar":{"type":"image","image_class":"gravatar_image","sso_image_class":"","avatar_url":"https://secure.gravatar.com/avatar/8f6284"}},"created_at":"2024-08-18T22:40:42.000-07:00","updated_at":"2024-08-18T22:40:42.000-07:00","attachments":[],"inline_attachments":[],"shared_attachments":[],"is_private":false,"seen_by":[8610546],"isTask":false,"task_info":{},"requester":null,"commenter_id":139207697,"commenter_type":"Incident","origin":0}],"attachments":[],"statistics":[{"statistic_type":"State Changed","time":"00:01","time_elapsed":"00:01","business_time_elapsed":"00:00","value":"2024-08-20 07:59:20 UTC"},{"statistic_type":"sla_state_changed","time":"00:00","time_elapsed":"00:00","business_time_elapsed":"00:00","value":"2024-08-20 07:58:48 UTC"},{"statistic_type":"to_resolve","time":"00:01","time_elapsed":"00:01","business_time_elapsed":"00:00","value":"2024-08-20 07:59:20 UTC"},{"statistic_type":"to_close","time":"00:02","time_elapsed":"00:02","business_time_elapsed":"00:00","value":"2024-08-18 13:41:58 UTC"}],"tags":[{"name":"emr"}],"associated_sla_names":["not_resolved"],"is_customer_satisfied":"Yes","customer_satisfaction_response":"optimistic, aren't we?","total_time_spent":0,"resolution":null,"resolution_type":"Done"}]}}},"application/xml":{"schema":{"description":"List of incidents","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}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","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<id>1</id>\n\t<number>1</number>\n\t<name>Incident Name</name>\n\t<description>description</description>\n\t<description_no_html>description</description_no_html>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<category>\n\t\t<id>1</id>\n\t\t<name>Category / Subcategory name</name>\n\t\t<default_tags>tag1, tag2</default_tags>\n\t\t<parent_id>1</parent_id>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t<deleted>true</deleted>\n\t</category>\n\t<subcategory>\n\t\t<id>1</id>\n\t\t<name>Category / Subcategory name</name>\n\t\t<default_tags>tag1, tag2</default_tags>\n\t\t<parent_id>1</parent_id>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t<deleted>true</deleted>\n\t</subcategory>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n\t<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n\t<due_at>2020-01-01T00:00:00.000+00:00</due_at>\n\t<number_of_comments>0</number_of_comments>\n\t<user_saw_all_comments>true</user_saw_all_comments>\n\t<is_service_request>true</is_service_request>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<resolved_by>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<title>title</title>\n\t\t<email>john.doe@email.com</email>\n\t\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n\t\t<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n\t\t<last_login>2020-01-01T00:00:00.000+00:00</last_login>\n\t\t<phone>0123-456-789</phone>\n\t\t<mobile_phone>0123-456-789</mobile_phone>\n\t\t<role>\n\t\t\t<id>1</id>\n\t\t\t<name>Requester</name>\n\t\t\t<description>Requester role</description>\n\t\t\t<portal>true</portal>\n\t\t\t<show_my_tasks>true</show_my_tasks>\n\t\t</role>\n\t\t<available_for_assignment>true</available_for_assignment>\n\t\t<can_be_available_for_assignment>true</can_be_available_for_assignment>\n\t\t<provider>provider</provider>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t\t<reports_to>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</reports_to>\n\t</resolved_by>\n\t<resolution_description>description</resolution_description>\n\t<resolution_code>Done</resolution_code>\n\t<customer_satisfaction_survey_sent_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_sent_at>\n\t<customer_satisfaction_survey_completed_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_completed_at>\n\t<custom>2023-01-01 00:00:00.000</custom>\n\t<href>https://mydomain.com/object_type/1</href>\n\t<href_account_domain>https://mydomain.com/object_type/1</href_account_domain>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<origin>api</origin>\n\t<price>1234.00 USD</price>\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","description":"The name property accepts a maximum of 255 chars. values exceeding this limit will be truncated with ellipsis"},"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","nullable":true,"example":"string"},"state_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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":{"description":"Incident can have only one Problem associated","anyOf":[{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"array","maxItems":1,"items":{"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"group_assignee":{"name":"Network Team"},"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}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}],"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","description":"The name property accepts a maximum of 255 chars. values exceeding this limit will be truncated with ellipsis"},"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","nullable":true,"example":"string"},"state_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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":{"description":"Incident can have only one Problem associated","anyOf":[{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"array","maxItems":1,"items":{"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":"<incident>\n\t<name>Incident Name</name>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<description>string</description>\n\t<state_id>1</state_id>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<assignee_id>1</assignee_id>\n\t<group_assignee_id>1</group_assignee_id>\n\t<priority>1</priority>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<category>\n\t\t<name>Object Name</name>\n\t</category>\n\t<subcategory>\n\t\t<name>Object Name</name>\n\t</subcategory>\n\t<due_at>Jan 01,2025</due_at>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<incidents>1</incidents>\n\t<solutions>1</solutions>\n\t<changes>1</changes>\n\t<problems>1</problems>\n\t<releases>1</releases>\n</incident>"}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","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":{"id":10000,"number":1000,"name":"Incident Name","description":"<p>description</p>","description_no_html":"description","state":"New","priority":"High","category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"assignee":{"group_id":1,"is_user":"true","id":1,"name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"requester":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"created_at":"2024-01-01T00:00:00.000+01:00","updated_at":"2024-01-01T00:00:00.000+01:00","due_at":"2025-01-01T00:00:00.000+01:00","sla_violations":[{"id":1000,"name":"SLA0001","sla_id":289,"sla_type":"not_commented","resolved":false,"time_delay":1,"time_units":"minutes","assignee":{"id":1,"name":"John Doe"},"group_assignee":{"id":1,"name":"Network Team"}}],"number_of_comments":0,"user_saw_all_comments":true,"is_service_request":false,"created_by":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"resolved_by":{"id":1,"name":"John Doe","disabled":false,"title":"title","email":"john.doe@email.com","created_at":"2023-01-01T00:00:00.000-00:00","updated_at":"2023-01-01T00:00:00.000-00:00","last_login":"2023-01-01T00:00:00.000-00:00","phone":"0123-456-789","mobile_phone":"0987-654-321","role":{"id":1,"name":"Administrator","description":"description","portal":false,"show_my_tasks":false},"group_ids":[1],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"provider","custom_fields_values":[],"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{}},"resolution_description":"description","resolution_code":"Done","customer_satisfaction_survey_sent_at":"2020-01-01T00:00:00.000-00:00","customer_satisfaction_survey_completed_at":"2020-01-01T00:00:00.000-00:00","custom":"2020-01-01 00:00:00.000","href":"http://mydomain.com/incidents/100","href_account_domain":"http://mydomain.com/incidents/100","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"cc":["jane.doe@email.com"],"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"}}],"origin":"api","price":"1234.00 USD","releases":[{"id":100,"href":"https://mydomain.com/releases/100"}],"problems":[{"id":100,"href":"https://mydomain.com/problems/100"}],"incidents":[{"id":100,"href":"https://mydomain.com/incidents/100"}],"changes":[{"id":100,"href":"https://mydomain.com/changes/100"}],"tasks":[{"id":100,"href":"https://mydomain.com/incidents/100/tasks/100"}],"time_tracks":[{"id":100,"href":"https://mydomain.com/incidents/100/time_tracks/100"}],"solutions":[{"id":100,"href":"https://mydomain.com/solutions/100"}],"assets":[{"id":100,"href":"https://mydomain.com/hardwares/100"}],"mobiles":[{"id":100,"href":"https://mydomain.com/mobiles/100"}],"other_assets":[{"id":100,"href":"https://mydomain.com/other_assets/100"}],"configuration_items":[{"id":100,"href":"https://mydomain.com/configuration_items/100"}],"discovery_hardware":[{"id":100,"href":"https://mydomain.com/descovery_hardwares/100"}],"purchase_orders":[{"id":100,"href":"https://mydomain.com/purchase_orders/100"}]}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","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":"<id>1</id>\n<number>1</number>\n<name>Incident Name</name>\n<description>description</description>\n<description_no_html>description</description_no_html>\n<state>New</state>\n<priority>High</priority>\n<category>\n\t<id>1</id>\n\t<name>Category / Subcategory name</name>\n\t<default_tags>tag1, tag2</default_tags>\n\t<parent_id>1</parent_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<deleted>true</deleted>\n</category>\n<subcategory>\n\t<id>1</id>\n\t<name>Category / Subcategory name</name>\n\t<default_tags>tag1, tag2</default_tags>\n\t<parent_id>1</parent_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<deleted>true</deleted>\n</subcategory>\n<assignee>\n\t<group_id>1</group_id>\n\t<is_user>true</is_user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<email>john.doe@email.com</email>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</assignee>\n<group_assignee>\n\t<group_id>1</group_id>\n\t<is_user>false</is_user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<description>John Doe</description>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</group_assignee>\n<requester>\n\t<id>1</id>\n\t<account_id>1</account_id>\n\t<user_id>1</user_id>\n\t<email>john.doe@email.com</email>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</requester>\n<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n<due_at>2020-01-01T00:00:00.000+00:00</due_at>\n<number_of_comments>0</number_of_comments>\n<user_saw_all_comments>true</user_saw_all_comments>\n<is_service_request>true</is_service_request>\n<created_by>\n\t<id>1</id>\n\t<account_id>1</account_id>\n\t<user_id>1</user_id>\n\t<email>john.doe@email.com</email>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</created_by>\n<resolved_by>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<title>title</title>\n\t<email>john.doe@email.com</email>\n\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n\t<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n\t<last_login>2020-01-01T00:00:00.000+00:00</last_login>\n\t<phone>0123-456-789</phone>\n\t<mobile_phone>0123-456-789</mobile_phone>\n\t<role>\n\t\t<id>1</id>\n\t\t<name>Requester</name>\n\t\t<description>Requester role</description>\n\t\t<portal>true</portal>\n\t\t<show_my_tasks>true</show_my_tasks>\n\t</role>\n\t<available_for_assignment>true</available_for_assignment>\n\t<can_be_available_for_assignment>true</can_be_available_for_assignment>\n\t<provider>provider</provider>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n</resolved_by>\n<resolution_description>description</resolution_description>\n<resolution_code>Done</resolution_code>\n<customer_satisfaction_survey_sent_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_sent_at>\n<customer_satisfaction_survey_completed_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_completed_at>\n<custom>2023-01-01 00:00:00.000</custom>\n<href>https://mydomain.com/object_type/1</href>\n<href_account_domain>https://mydomain.com/object_type/1</href_account_domain>\n<site>\n\t<id>1</id>\n\t<name>Austin TX, USA</name>\n\t<description>AUS</description>\n\t<location>AUS</location>\n\t<timezone>UTC-6h</timezone>\n</site>\n<department>\n\t<id>1</id>\n\t<name>Support</name>\n\t<description>Support Department</description>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n</department>\n<origin>api</origin>\n<price>1234.00 USD</price>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the problems","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as comments, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}}}}},"examples":{"layout=short":{"value":{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/100"}]}}},"layout=long":{"value":{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/100"}],"comments":[{"id":10,"body":"everybody","user":{"id":4713,"name":"Simmy","email":"simmy.dian@mydomain.com","avatar":{"type":"image","image_class":"gravatar_image","sso_image_class":"","avatar_url":"https://secure.gravatar.com/avatar/8f6284"}},"created_at":"2024-08-18T22:40:42.000-07:00","updated_at":"2024-08-18T22:40:42.000-07:00","attachments":[],"inline_attachments":[],"shared_attachments":[],"is_private":false,"seen_by":[8610546],"isTask":false,"task_info":{},"requester":null,"commenter_id":139207697,"commenter_type":"Incident","origin":0}],"statistics":[{"statistic_type":"State Changed","time":"00:01","time_elapsed":"00:01","business_time_elapsed":"00:00","value":"2024-08-20 07:59:20 UTC"},{"statistic_type":"sla_state_changed","time":"00:00","time_elapsed":"00:00","business_time_elapsed":"00:00","value":"2024-08-20 07:58:48 UTC"},{"statistic_type":"to_resolve","time":"00:01","time_elapsed":"00:01","business_time_elapsed":"00:00","value":"2024-08-20 07:59:20 UTC"},{"statistic_type":"to_close","time":"00:02","time_elapsed":"00:02","business_time_elapsed":"00:00","value":"2024-08-18 13:41:58 UTC"}],"attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"},{"id":212598158,"content_type":"text/plain","size":251,"filename":"notpersonal.txt","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true","secure_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain","link_uuid_url":"/attachments/9d2e6444a7773cacab39","uuid":"9d2e6444a7773cacab39"}],"shared_attachments":[{"id":212598158,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":true,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"}],"total_time_spent":10}}}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Problem Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<root_cause>Root cause description</root_cause>\n\t<symptoms>Symptoms description</symptoms>\n\t<workaround>Workaround description</workaround>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n</problem>"}}},"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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"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"},"group_assignee":{"name":"Network Team"},"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],"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"problem":{"type":"object","properties":{"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":"<problem>\n\t<name>Problem Name</name>\n\t<description>string</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>New</state>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<priority>High</priority>\n\t<root_cause>Root cause description</root_cause>\n\t<symptoms>Symptoms description</symptoms>\n\t<workaround>workaround description</workaround>\n\t<add_to_tag_list>tag1</add_to_tag_list>\n\t<remove_from_tag_list>tag2</remove_from_tag_list>\n\t<tag_list>tag1</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</problem>"}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Problem Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<root_cause>Root cause description</root_cause>\n\t<symptoms>Symptoms description</symptoms>\n\t<workaround>Workaround description</workaround>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n</problem>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the problems","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as comments, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}}}}}]}},"examples":{"layout=short":{"value":[{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/100"}]}}]},"layout=long":{"value":[{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/100"}],"comments":[{"id":10,"body":"everybody","user":{"id":4713,"name":"Simmy","email":"simmy.dian@mydomain.com","avatar":{"type":"image","image_class":"gravatar_image","sso_image_class":"","avatar_url":"https://secure.gravatar.com/avatar/8f6284"}},"created_at":"2024-08-18T22:40:42.000-07:00","updated_at":"2024-08-18T22:40:42.000-07:00","attachments":[],"inline_attachments":[],"shared_attachments":[],"is_private":false,"seen_by":[8610546],"isTask":false,"task_info":{},"requester":null,"commenter_id":139207697,"commenter_type":"Incident","origin":0}],"statistics":[{"statistic_type":"State Changed","time":"00:01","time_elapsed":"00:01","business_time_elapsed":"00:00","value":"2024-08-20 07:59:20 UTC"},{"statistic_type":"sla_state_changed","time":"00:00","time_elapsed":"00:00","business_time_elapsed":"00:00","value":"2024-08-20 07:58:48 UTC"},{"statistic_type":"to_resolve","time":"00:01","time_elapsed":"00:01","business_time_elapsed":"00:00","value":"2024-08-20 07:59:20 UTC"},{"statistic_type":"to_close","time":"00:02","time_elapsed":"00:02","business_time_elapsed":"00:00","value":"2024-08-18 13:41:58 UTC"}],"attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"},{"id":212598158,"content_type":"text/plain","size":251,"filename":"notpersonal.txt","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true","secure_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain","link_uuid_url":"/attachments/9d2e6444a7773cacab39","uuid":"9d2e6444a7773cacab39"}],"shared_attachments":[{"id":212598158,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":true,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"}],"total_time_spent":10}}]}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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<problem>\n\t\t<id>1</id>\n\t\t<name>Problem Name</name>\n\t\t<description>description</description>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<state>New</state>\n\t\t<priority>High</priority>\n\t\t<root_cause>Root cause description</root_cause>\n\t\t<symptoms>Symptoms description</symptoms>\n\t\t<workaround>Workaround description</workaround>\n\t\t<created_by>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</created_by>\n\t\t<assignee>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</assignee>\n\t\t<group_assignee>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>false</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<description>John Doe</description>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</group_assignee>\n\t\t<requester>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</requester>\n\t</problem>\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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"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"},"group_assignee":{"name":"Network Team"},"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],"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"problem":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":"<problem>\n\t<name>Problem Name</name>\n\t<description>string</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>New</state>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<priority>High</priority>\n\t<root_cause>Root cause description</root_cause>\n\t<symptoms>Symptoms description</symptoms>\n\t<workaround>workaround description</workaround>\n\t<add_to_tag_list>tag1</add_to_tag_list>\n\t<remove_from_tag_list>tag2</remove_from_tag_list>\n\t<tag_list>tag1</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</problem>"}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Problem Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<root_cause>Root cause description</root_cause>\n\t<symptoms>Symptoms description</symptoms>\n\t<workaround>Workaround description</workaround>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n</problem>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the changes","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as comments, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}}}}},"examples":{"layout=short":{"value":{"change":{"id":"10000","number":"1000","name":"Change Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/100"}]}}},"layout=long":{"value":{"change":{"id":"10000","number":"1000","name":"Change Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/100"}],"attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"},{"id":212598158,"content_type":"text/plain","size":251,"filename":"notpersonal.txt","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true","secure_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain","link_uuid_url":"/attachments/9d2e6444a7773cacab39","uuid":"9d2e6444a7773cacab39"}],"statistics":[{"statistic_type":"last_state_change","time":null,"time_elapsed":null,"business_time_elapsed":null,"value":"{\"last_updated\":\"2024-12-21T23:39:47+02:00\",\"history\":[{\"id\":347869,\"title\":\"\",\"startTime\":\"2024-09-15T14:49:09.000-07:00\",\"endTime\":\"2024-12-21T17:11:08.629+00:00\",\"timeSpent\":8364120,\"timeSpentBH\":1976400,\"timeSinceCreation\":0,\"timeSinceCreationBH\":0,\"isCurrent\":false,\"isDeleted\":false}],\"summary\":{\"347869\":8364119.83482472},\"bh_summary\":{\"347869\":1976400}}"},{"statistic_type":"to_assignment","time":"2323:09","time_elapsed":"2323:09","business_time_elapsed":"549:00","value":"2024-12-21 16:57:12 UTC"},{"statistic_type":"last_reassigned","time":null,"time_elapsed":null,"business_time_elapsed":null,"value":"{\"last_updated\":\"2024-12-21T19:36:33+02:00\",\"history\":[{\"id\":12034043,\"title\":\"Abhilash\",\"startTime\":\"2024-12-21T18:57:12.000+02:00\",\"endTime\":\"2024-12-21T17:03:27.449+00:00\",\"timeSpent\":375,\"timeSpentBH\":0,\"timeSinceCreation\":8363283,\"timeSinceCreationBH\":1976400,\"isCurrent\":false,\"isDeleted\":false}],\"summary\":{\"12034043\":375.687147794},\"bh_summary\":{\"12034043\":0}}"},{"statistic_type":"to_approval","time":"2327:50","time_elapsed":"2327:50","business_time_elapsed":"549:00","value":"2024-12-21 21:38:59 UTC"},{"statistic_type":"to_decline","time":"2323:31","time_elapsed":"2323:31","business_time_elapsed":"549:00","value":"2024-12-21 17:19:37 UTC"},{"statistic_type":"to_closed_completed","time":"2327:51","time_elapsed":"2327:51","business_time_elapsed":"549:00","value":"2024-12-21 21:39:47 UTC"},{"statistic_type":"to_closed_incomplete","time":"2323:32","time_elapsed":"2323:32","business_time_elapsed":"549:00","value":"2024-12-21 17:20:59 UTC"},{"statistic_type":"to_first_response","time":"2326:47","time_elapsed":"2326:47","business_time_elapsed":"549:00","value":"2024-12-21 20:35:16 UTC"}],"shared_attachments":[{"id":212598158,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":true,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"}],"comments":[{"id":10,"body":"everybody","user":{"id":4713,"name":"Simmy","email":"simmy.dian@mydomain.com","avatar":{"type":"image","image_class":"gravatar_image","sso_image_class":"","avatar_url":"https://secure.gravatar.com/avatar/8f6284"}},"created_at":"2024-08-18T22:40:42.000-07:00","updated_at":"2024-08-18T22:40:42.000-07:00","attachments":[],"inline_attachments":[],"shared_attachments":[],"is_private":false,"seen_by":[8610546],"isTask":false,"task_info":{},"requester":null,"commenter_id":139207697,"commenter_type":"Incident","origin":0}],"number_of_comments":1,"user_saw_all_comments":true}}}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Change Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n</change>"}}},"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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"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"},"group_assignee":{"name":"Helpdesk Team"},"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"}}]},"configuration_item_ids":[100],"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}]}}},"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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":"<change>\n\t<name>Change Name</name>\n\t<change_type>1</change_type>\n\t<description>string</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>New</state>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<planned_start_at>2025-01-01 00:00</planned_start_at>\n\t<planned_end_at>2025-01-01 05:00</planned_end_at>\n\t<add_to_tag_list>tag1</add_to_tag_list>\n\t<remove_from_tag_list>tag2</remove_from_tag_list>\n\t<tag_list>tag1</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<incidents>1</incidents>\n\t<problems>1</problems>\n\t<releases>1</releases>\n</change>"}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Change Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n</change>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the changes","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as comments, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}}}}}]}},"examples":{"layout=short":{"value":[{"change":{"id":"10000","number":"1000","name":"Change Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/100"}]}}]},"layout=long":{"value":[{"change":{"id":"10000","number":"1000","name":"Change Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/100"}],"attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"},{"id":212598158,"content_type":"text/plain","size":251,"filename":"notpersonal.txt","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true","secure_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain","link_uuid_url":"/attachments/9d2e6444a7773cacab39","uuid":"9d2e6444a7773cacab39"}],"statistics":[{"statistic_type":"last_state_change","time":null,"time_elapsed":null,"business_time_elapsed":null,"value":"{\"last_updated\":\"2024-12-21T23:39:47+02:00\",\"history\":[{\"id\":347869,\"title\":\"\",\"startTime\":\"2024-09-15T14:49:09.000-07:00\",\"endTime\":\"2024-12-21T17:11:08.629+00:00\",\"timeSpent\":8364120,\"timeSpentBH\":1976400,\"timeSinceCreation\":0,\"timeSinceCreationBH\":0,\"isCurrent\":false,\"isDeleted\":false}],\"summary\":{\"347869\":8364119.83482472},\"bh_summary\":{\"347869\":1976400}}"},{"statistic_type":"to_assignment","time":"2323:09","time_elapsed":"2323:09","business_time_elapsed":"549:00","value":"2024-12-21 16:57:12 UTC"},{"statistic_type":"last_reassigned","time":null,"time_elapsed":null,"business_time_elapsed":null,"value":"{\"last_updated\":\"2024-12-21T19:36:33+02:00\",\"history\":[{\"id\":12034043,\"title\":\"Abhilash\",\"startTime\":\"2024-12-21T18:57:12.000+02:00\",\"endTime\":\"2024-12-21T17:03:27.449+00:00\",\"timeSpent\":375,\"timeSpentBH\":0,\"timeSinceCreation\":8363283,\"timeSinceCreationBH\":1976400,\"isCurrent\":false,\"isDeleted\":false}],\"summary\":{\"12034043\":375.687147794},\"bh_summary\":{\"12034043\":0}}"},{"statistic_type":"to_approval","time":"2327:50","time_elapsed":"2327:50","business_time_elapsed":"549:00","value":"2024-12-21 21:38:59 UTC"},{"statistic_type":"to_decline","time":"2323:31","time_elapsed":"2323:31","business_time_elapsed":"549:00","value":"2024-12-21 17:19:37 UTC"},{"statistic_type":"to_closed_completed","time":"2327:51","time_elapsed":"2327:51","business_time_elapsed":"549:00","value":"2024-12-21 21:39:47 UTC"},{"statistic_type":"to_closed_incomplete","time":"2323:32","time_elapsed":"2323:32","business_time_elapsed":"549:00","value":"2024-12-21 17:20:59 UTC"},{"statistic_type":"to_first_response","time":"2326:47","time_elapsed":"2326:47","business_time_elapsed":"549:00","value":"2024-12-21 20:35:16 UTC"}],"shared_attachments":[{"id":212598158,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":true,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"}],"comments":[{"id":10,"body":"everybody","user":{"id":4713,"name":"Simmy","email":"simmy.dian@mydomain.com","avatar":{"type":"image","image_class":"gravatar_image","sso_image_class":"","avatar_url":"https://secure.gravatar.com/avatar/8f6284"}},"created_at":"2024-08-18T22:40:42.000-07:00","updated_at":"2024-08-18T22:40:42.000-07:00","attachments":[],"inline_attachments":[],"shared_attachments":[],"is_private":false,"seen_by":[8610546],"isTask":false,"task_info":{},"requester":null,"commenter_id":139207697,"commenter_type":"Incident","origin":0}],"number_of_comments":1,"user_saw_all_comments":true}}]}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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<change>\n\t\t<id>1</id>\n\t\t<name>Change Name</name>\n\t\t<description>description</description>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<state>New</state>\n\t\t<priority>High</priority>\n\t\t<change_plan>change plan</change_plan>\n\t\t<rollback_plan>rollback plan</rollback_plan>\n\t\t<test_plan>test plan</test_plan>\n\t\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t\t<created_by>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</created_by>\n\t\t<assignee>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</assignee>\n\t\t<group_assignee>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>false</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<description>John Doe</description>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</group_assignee>\n\t\t<requester>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</requester>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t</change>\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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"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"},"group_assignee":{"name":"Helpdesk Team"},"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"}}]},"configuration_item_ids":[100],"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}]}}},"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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":"<change>\n\t<name>Change Name</name>\n\t<change_type>1</change_type>\n\t<description>string</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>New</state>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<planned_start_at>2025-01-01 00:00</planned_start_at>\n\t<planned_end_at>2025-01-01 05:00</planned_end_at>\n\t<add_to_tag_list>tag1</add_to_tag_list>\n\t<remove_from_tag_list>tag2</remove_from_tag_list>\n\t<tag_list>tag1</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<incidents>1</incidents>\n\t<problems>1</problems>\n\t<releases>1</releases>\n</change>"}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Change Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n</change>"}}},"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}]},"default_group_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"}}}}},"default_group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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"}}}}},"default_group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Change Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>Approved</state>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<default_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</default_assignee>\n\t<default_group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</default_group_assignee>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<show_in_portal>true</show_in_portal>\n</change_catalog>"}}},"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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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}]},"default_group_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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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,"default_group_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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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}]},"default_group_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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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>\n\t<name>Change Name</name>\n\t<change_type>1</change_type>\n\t<description>string</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>Approved</state>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<add_to_tag_list>tag1</add_to_tag_list>\n\t<remove_from_tag_list>tag2</remove_from_tag_list>\n\t<tag_list>tag1</tag_list>\n\t<show_in_portal>true</show_in_portal>\n</change_catalog>"}}},"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}]},"default_group_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"}}}}},"default_group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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"}}}}},"default_group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Change Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>Approved</state>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<default_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</default_assignee>\n\t<default_group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</default_group_assignee>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<show_in_portal>true</show_in_portal>\n</change_catalog>"}}},"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}]},"default_group_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"}}}}},"default_group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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"}}}}},"default_group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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<change_catalog>\n\t\t<id>1</id>\n\t\t<name>Change Name</name>\n\t\t<description>description</description>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<state>Approved</state>\n\t\t<priority>High</priority>\n\t\t<change_plan>change plan</change_plan>\n\t\t<rollback_plan>rollback plan</rollback_plan>\n\t\t<test_plan>test plan</test_plan>\n\t\t<created_by>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</created_by>\n\t\t<default_assignee>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</default_assignee>\n\t\t<default_group_assignee>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>false</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<description>John Doe</description>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</default_group_assignee>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t\t<show_in_portal>true</show_in_portal>\n\t</change_catalog>\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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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}]},"default_group_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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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,"default_group_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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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}]},"default_group_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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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>\n\t<name>Change Name</name>\n\t<change_type>1</change_type>\n\t<description>string</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>Approved</state>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<add_to_tag_list>tag1</add_to_tag_list>\n\t<remove_from_tag_list>tag2</remove_from_tag_list>\n\t<tag_list>tag1</tag_list>\n\t<show_in_portal>true</show_in_portal>\n</change_catalog>"}}},"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}]},"default_group_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"}}}}},"default_group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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"}}}}},"default_group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Change Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>Approved</state>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<default_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</default_assignee>\n\t<default_group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</default_group_assignee>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<show_in_portal>true</show_in_portal>\n</change_catalog>"}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/change_catalogs/{id}/change_requests":{"post":{"operationId":"createChangeRequest","description":"Request a Change","tags":["Change 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":"Change Request fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change_request":{"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}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"Change Plan"},"test_plan":{"type":"string","example":"Test Plan"},"rollback_plan":{"type":"string","example":"Rollback Plan"},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"request_variables_attributes":{"anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Variable name"},"value":{"type":"string","example":"Content"},"user_value":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}}]}}}}},"example":{"change_request":{"name":"Change name","description":"Change description","change_plan":"Change plan","test_plan":"Test plan","rollback_plan":"Rollback plan","priority":"Low","change_type":"None","assignee":{"email":"john.doe@email.com"},"group_assignee":{"name":"Network Team"},"site":{"name":"Site name"},"department":{"name":"Department name"},"request_variables_attributes":[{"name":"Variable name","value":"Content"},{"name":"User Variable","user_value":{"email":"john.doe@email.com"}},{"name":"MultiPickList variable","value":"option1#dlmtr#option2"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change_request":{"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}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"Change Plan"},"test_plan":{"type":"string","example":"Test Plan"},"rollback_plan":{"type":"string","example":"Rollback Plan"},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"request_variables_attributes":{"anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Variable name"},"value":{"type":"string","example":"Content"},"user_value":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}}]}}}}},"example":"<change_request>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<priority>High</priority>\n\t<change_plan>Change Plan</change_plan>\n\t<test_plan>Test Plan</test_plan>\n\t<rollback_plan>Rollback Plan</rollback_plan>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<request_variables_attributes>1</request_variables_attributes>\n</change_request>"}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Change Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<change_plan>change plan</change_plan>\n\t<rollback_plan>rollback plan</rollback_plan>\n\t<test_plan>test plan</test_plan>\n\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n</change>"}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Release Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<plan>plan description</plan>\n\t<build>build description</build>\n\t<deploy>deploy description</deploy>\n\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n</release>"}}},"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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"approval_levels_attributes":{"type":"object","properties":{"1":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}},"2":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"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"},"group_assignee":{"name":"Network Team"},"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],"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"release":{"type":"object","properties":{"name":{"type":"string","example":"Release Name"},"description":{"type":"string","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"approval_levels_attributes":{"type":"object","properties":{"1":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}},"2":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}}}}}}}},"example":"<release>\n\t<name>Release Name</name>\n\t<description>string</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>New</state>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<priority>High</priority>\n\t<plan>plan description</plan>\n\t<build>build description</build>\n\t<deploy>deploy description</deploy>\n\t<planned_start_at>2025-01-01 00:00</planned_start_at>\n\t<planned_end_at>2025-01-01 05:00</planned_end_at>\n\t<add_to_tag_list>tag1</add_to_tag_list>\n\t<remove_from_tag_list>tag2</remove_from_tag_list>\n\t<tag_list>tag1</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<approval_levels_attributes>\n\t\t<1>\n\t\t\t<approver_ids>1, 2, 3</approver_ids>\n\t\t\t<approval_condition>1</approval_condition>\n\t\t</1>\n\t\t<2>\n\t\t\t<approver_ids>1, 2, 3</approver_ids>\n\t\t\t<approval_condition>1</approval_condition>\n\t\t</2>\n\t</approval_levels_attributes>\n</release>"}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Release Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<plan>plan description</plan>\n\t<build>build description</build>\n\t<deploy>deploy description</deploy>\n\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n</release>"}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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<release>\n\t\t<id>1</id>\n\t\t<name>Release Name</name>\n\t\t<description>description</description>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<state>New</state>\n\t\t<priority>High</priority>\n\t\t<plan>plan description</plan>\n\t\t<build>build description</build>\n\t\t<deploy>deploy description</deploy>\n\t\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t\t<created_by>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</created_by>\n\t\t<assignee>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</assignee>\n\t\t<group_assignee>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>false</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<description>John Doe</description>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</group_assignee>\n\t\t<requester>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</requester>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t</release>\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","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"approval_levels_attributes":{"type":"object","properties":{"1":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}},"2":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"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"},"group_assignee":{"name":"Network Team"},"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],"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"release":{"type":"object","required":["name","requester"],"properties":{"name":{"type":"string","example":"Release Name"},"description":{"type":"string","nullable":true,"example":"string"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"group_assignee":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"approval_levels_attributes":{"type":"object","properties":{"1":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}},"2":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}}}}}}}},"example":"<release>\n\t<name>Release Name</name>\n\t<description>string</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>New</state>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<group_assignee>\n\t\t<name>Object Name</name>\n\t</group_assignee>\n\t<priority>High</priority>\n\t<plan>plan description</plan>\n\t<build>build description</build>\n\t<deploy>deploy description</deploy>\n\t<planned_start_at>2025-01-01 00:00</planned_start_at>\n\t<planned_end_at>2025-01-01 05:00</planned_end_at>\n\t<add_to_tag_list>tag1</add_to_tag_list>\n\t<remove_from_tag_list>tag2</remove_from_tag_list>\n\t<tag_list>tag1</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<approval_levels_attributes>\n\t\t<1>\n\t\t\t<approver_ids>1, 2, 3</approver_ids>\n\t\t\t<approval_condition>1</approval_condition>\n\t\t</1>\n\t\t<2>\n\t\t\t<approver_ids>1, 2, 3</approver_ids>\n\t\t\t<approval_condition>1</approval_condition>\n\t\t</2>\n\t</approval_levels_attributes>\n</release>"}}},"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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"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"}],"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"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/purchase_orders/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}]},"default_group_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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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>\n\t<id>1</id>\n\t<name>Release Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>New</state>\n\t<priority>High</priority>\n\t<plan>plan description</plan>\n\t<build>build description</build>\n\t<deploy>deploy description</deploy>\n\t<planned_start_at>2025-01-01T00:00:00.000+01:00</planned_start_at>\n\t<planned_end_at>2025-01-01T05:00:00.000+01:00</planned_end_at>\n\t<created_by>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</created_by>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<group_assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>false</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<description>John Doe</description>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</group_assignee>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n</release>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the solutions","value":{"":"layout=short"}},"example2":{"summary":"Includes the same properties as the short layout, with additional details such as comments and total time spent","value":{"":"layout=long"}}}}],"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"},"href":{"type":"string","example":"/solutions/10000.xml"},"number":{"type":"integer","example":1000},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description_no_html."},"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"},"isAllowToVote":{"type":"boolean","example":true},"number_of_attachments":{"type":"integer","example":0},"attachments":{"type":"array","items":{"type":"object"},"example":[{}]},"number_of_shared_attachments":{"type":"integer","example":0},"shared_attachments":{"type":"array","items":{"type":"object"},"example":[{}]}}}}},"examples":{"layout=short":{"value":{"solution":{"id":"10000","name":"Solution Name","href":"/solutions/10000.json","number":"1000","description":"description","description_no_html":"description_no_html.","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"created_at":"2025-01-01T00:00:00.000+01:00","isAllowToVote":true,"number_of_attachments":0,"attachments":[],"number_of_shared_attachments":0,"shared_attachments":[]}}},"layout=long":{"value":{"solution":{"id":"10000","name":"Solution Name","href":"/solutions/10000.json","number":"1000","description":"description","description_no_html":"description_no_html.","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"created_at":"2025-01-01T00:00:00.000+01:00","isAllowToVote":true,"number_of_attachments":0,"attachments":[],"number_of_shared_attachments":0,"shared_attachments":[],"comments":[{"id":10,"body":"everybody","user":{"id":4713,"name":"Simmy","email":"simmy.dian@mydomain.com","avatar":{"type":"image","image_class":"gravatar_image","sso_image_class":"","avatar_url":"https://secure.gravatar.com/avatar/8f6284"}},"created_at":"2024-08-18T22:40:42.000-07:00","updated_at":"2024-08-18T22:40:42.000-07:00","attachments":[],"inline_attachments":[],"shared_attachments":[],"is_private":false,"seen_by":[8610546],"isTask":false,"task_info":{},"requester":null,"commenter_id":139207697,"commenter_type":"Incident","origin":0}],"total_time_spent":10}}}}},"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"},"href":{"type":"string","example":"/solutions/10000.xml"},"number":{"type":"integer","example":1000},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description_no_html."},"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"},"isAllowToVote":{"type":"boolean","example":true},"number_of_attachments":{"type":"integer","example":0},"attachments":{"type":"array","items":{"type":"object"},"example":[{}]},"number_of_shared_attachments":{"type":"integer","example":0},"shared_attachments":{"type":"array","items":{"type":"object"},"example":[{}]}}}}},"example":"<solution>\n\t<id>1</id>\n\t<name>Solution Name</name>\n\t<href>/solutions/10000.xml</href>\n\t<number>1000</number>\n\t<description>description</description>\n\t<description_no_html>description_no_html.</description_no_html>\n\t<creator>\n\t\t<id>1</id>\n\t\t<name>tag name</name>\n\t\t<email>john.doe@email.com</email>\n\t</creator>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<isAllowToVote>true</isAllowToVote>\n\t<number_of_attachments>0</number_of_attachments>\n\t<number_of_shared_attachments>0</number_of_shared_attachments>\n</solution>"}}},"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","nullable":true,"example":"string"},"state":{"type":"string","example":"Approved"},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"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","nullable":true,"example":"string"},"state":{"type":"string","example":"Approved"},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":"<solution>\n\t<name>Solution Name</name>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<description>string</description>\n\t<state>Approved</state>\n\t<category>\n\t\t<name>Object Name</name>\n\t</category>\n\t<subcategory>\n\t\t<name>Object Name</name>\n\t</subcategory>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</solution>"}}},"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"},"href":{"type":"string","example":"/solutions/10000.xml"},"number":{"type":"integer","example":1000},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description_no_html."},"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"},"isAllowToVote":{"type":"boolean","example":true},"number_of_attachments":{"type":"integer","example":0},"attachments":{"type":"array","items":{"type":"object"},"example":[{}]},"number_of_shared_attachments":{"type":"integer","example":0},"shared_attachments":{"type":"array","items":{"type":"object"},"example":[{}]}}}}},"example":{"solution":{"id":"10000","name":"Solution Name","href":"/solutions/10000.json","number":"1000","description":"description","description_no_html":"description_no_html.","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"created_at":"2025-01-01T00:00:00.000+01:00","isAllowToVote":true,"number_of_attachments":0,"attachments":[],"number_of_shared_attachments":0,"shared_attachments":[]}}},"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"},"href":{"type":"string","example":"/solutions/10000.xml"},"number":{"type":"integer","example":1000},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description_no_html."},"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"},"isAllowToVote":{"type":"boolean","example":true},"number_of_attachments":{"type":"integer","example":0},"attachments":{"type":"array","items":{"type":"object"},"example":[{}]},"number_of_shared_attachments":{"type":"integer","example":0},"shared_attachments":{"type":"array","items":{"type":"object"},"example":[{}]}}}}},"example":"<solution>\n\t<id>1</id>\n\t<name>Solution Name</name>\n\t<href>/solutions/10000.xml</href>\n\t<number>1000</number>\n\t<description>description</description>\n\t<description_no_html>description_no_html.</description_no_html>\n\t<creator>\n\t\t<id>1</id>\n\t\t<name>tag name</name>\n\t\t<email>john.doe@email.com</email>\n\t</creator>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<isAllowToVote>true</isAllowToVote>\n\t<number_of_attachments>0</number_of_attachments>\n\t<number_of_shared_attachments>0</number_of_shared_attachments>\n</solution>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the solutions","value":{"":"layout=short"}},"example2":{"summary":"Includes the same properties as the short layout, with additional details such as comments and total time spent","value":{"":"layout=long"}}}}],"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"},"href":{"type":"string","example":"/solutions/10000.xml"},"number":{"type":"integer","example":1000},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description_no_html."},"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"},"isAllowToVote":{"type":"boolean","example":true},"number_of_attachments":{"type":"integer","example":0},"attachments":{"type":"array","items":{"type":"object"},"example":[{}]},"number_of_shared_attachments":{"type":"integer","example":0},"shared_attachments":{"type":"array","items":{"type":"object"},"example":[{}]}}}}}},"examples":{"layout=short":{"value":[{"solution":{"id":"10000","name":"Solution Name","href":"/solutions/10000.json","number":"1000","description":"description","description_no_html":"description_no_html.","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"created_at":"2025-01-01T00:00:00.000+01:00","isAllowToVote":true,"number_of_attachments":0,"attachments":[],"number_of_shared_attachments":0,"shared_attachments":[]}}]},"layout=long":{"value":[{"solution":{"id":"10000","name":"Solution Name","href":"/solutions/10000.json","number":"1000","description":"description","description_no_html":"description_no_html.","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"created_at":"2025-01-01T00:00:00.000+01:00","isAllowToVote":true,"number_of_attachments":0,"attachments":[],"number_of_shared_attachments":0,"shared_attachments":[],"comments":[{"id":10,"body":"everybody","user":{"id":4713,"name":"Simmy","email":"simmy.dian@mydomain.com","avatar":{"type":"image","image_class":"gravatar_image","sso_image_class":"","avatar_url":"https://secure.gravatar.com/avatar/8f6284"}},"created_at":"2024-08-18T22:40:42.000-07:00","updated_at":"2024-08-18T22:40:42.000-07:00","attachments":[],"inline_attachments":[],"shared_attachments":[],"is_private":false,"seen_by":[8610546],"isTask":false,"task_info":{},"requester":null,"commenter_id":139207697,"commenter_type":"Incident","origin":0}],"total_time_spent":10}}]}}},"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"},"href":{"type":"string","example":"/solutions/10000.xml"},"number":{"type":"integer","example":1000},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description_no_html."},"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"},"isAllowToVote":{"type":"boolean","example":true},"number_of_attachments":{"type":"integer","example":0},"attachments":{"type":"array","items":{"type":"object"},"example":[{}]},"number_of_shared_attachments":{"type":"integer","example":0},"shared_attachments":{"type":"array","items":{"type":"object"},"example":[{}]}}}}}},"example":"<>\n\t<solution>\n\t\t<id>1</id>\n\t\t<name>Solution Name</name>\n\t\t<href>/solutions/10000.xml</href>\n\t\t<number>1000</number>\n\t\t<description>description</description>\n\t\t<description_no_html>description_no_html.</description_no_html>\n\t\t<creator>\n\t\t\t<id>1</id>\n\t\t\t<name>tag name</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t</creator>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t\t<isAllowToVote>true</isAllowToVote>\n\t\t<number_of_attachments>0</number_of_attachments>\n\t\t<number_of_shared_attachments>0</number_of_shared_attachments>\n\t</solution>\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","nullable":true,"example":"string"},"state":{"type":"string","example":"Approved"},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"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","nullable":true,"example":"string"},"state":{"type":"string","example":"Approved"},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":"<solution>\n\t<name>Solution Name</name>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<description>string</description>\n\t<state>Approved</state>\n\t<category>\n\t\t<name>Object Name</name>\n\t</category>\n\t<subcategory>\n\t\t<name>Object Name</name>\n\t</subcategory>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</solution>"}}},"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"},"href":{"type":"string","example":"/solutions/10000.xml"},"number":{"type":"integer","example":1000},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description_no_html."},"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"},"isAllowToVote":{"type":"boolean","example":true},"number_of_attachments":{"type":"integer","example":0},"attachments":{"type":"array","items":{"type":"object"},"example":[{}]},"number_of_shared_attachments":{"type":"integer","example":0},"shared_attachments":{"type":"array","items":{"type":"object"},"example":[{}]}}}}},"example":{"solution":{"id":"10000","name":"Solution Name","href":"/solutions/10000.json","number":"1000","description":"description","description_no_html":"description_no_html.","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"created_at":"2025-01-01T00:00:00.000+01:00","isAllowToVote":true,"number_of_attachments":0,"attachments":[],"number_of_shared_attachments":0,"shared_attachments":[]}}},"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"},"href":{"type":"string","example":"/solutions/10000.xml"},"number":{"type":"integer","example":1000},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description_no_html."},"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"},"isAllowToVote":{"type":"boolean","example":true},"number_of_attachments":{"type":"integer","example":0},"attachments":{"type":"array","items":{"type":"object"},"example":[{}]},"number_of_shared_attachments":{"type":"integer","example":0},"shared_attachments":{"type":"array","items":{"type":"object"},"example":[{}]}}}}},"example":"<solution>\n\t<id>1</id>\n\t<name>Solution Name</name>\n\t<href>/solutions/10000.xml</href>\n\t<number>1000</number>\n\t<description>description</description>\n\t<description_no_html>description_no_html.</description_no_html>\n\t<creator>\n\t\t<id>1</id>\n\t\t<name>tag name</name>\n\t\t<email>john.doe@email.com</email>\n\t</creator>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<isAllowToVote>true</isAllowToVote>\n\t<number_of_attachments>0</number_of_attachments>\n\t<number_of_shared_attachments>0</number_of_shared_attachments>\n</solution>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"origin":{"type":"string","example":"api"}}}}},"example":"<catalog_item>\n\t<id>1</id>\n\t<name>CI Name</name>\n\t<description>description</description>\n\t<expected_delivery_time>1 day</expected_delivery_time>\n\t<currency>USD</currency>\n\t<price>1</price>\n\t<show_price>true</show_price>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<category>\n\t\t<id>1</id>\n\t\t<name>Category / Subcategory name</name>\n\t\t<default_tags>tag1, tag2</default_tags>\n\t\t<parent_id>1</parent_id>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t<deleted>true</deleted>\n\t</category>\n\t<subcategory>\n\t\t<id>1</id>\n\t\t<name>Category / Subcategory name</name>\n\t\t<default_tags>tag1, tag2</default_tags>\n\t\t<parent_id>1</parent_id>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t<deleted>true</deleted>\n\t</subcategory>\n\t<origin>api</origin>\n</catalog_item>"}}},"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}]},"default_group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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","default_group_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}]},"default_group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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>\n\t<name>CI Name</name>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<description>description</description>\n\t<state>Approved</state>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<category>\n\t\t<name>Object Name</name>\n\t</category>\n\t<subcategory>\n\t\t<name>Object Name</name>\n\t</subcategory>\n\t<expected_delivery_time>1 day</expected_delivery_time>\n\t<currency>USD</currency>\n\t<price>1</price>\n\t<show_price>1</show_price>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n</catalog_item>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"origin":{"type":"string","example":"api"}}}}},"example":"<catalog_item>\n\t<id>1</id>\n\t<name>CI Name</name>\n\t<description>description</description>\n\t<expected_delivery_time>1 day</expected_delivery_time>\n\t<currency>USD</currency>\n\t<price>1</price>\n\t<show_price>true</show_price>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<category>\n\t\t<id>1</id>\n\t\t<name>Category / Subcategory name</name>\n\t\t<default_tags>tag1, tag2</default_tags>\n\t\t<parent_id>1</parent_id>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t<deleted>true</deleted>\n\t</category>\n\t<subcategory>\n\t\t<id>1</id>\n\t\t<name>Category / Subcategory name</name>\n\t\t<default_tags>tag1, tag2</default_tags>\n\t\t<parent_id>1</parent_id>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t<deleted>true</deleted>\n\t</subcategory>\n\t<origin>api</origin>\n</catalog_item>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"origin":{"type":"string","example":"api"}}}}}},"example":"<>\n\t<catalog_item>\n\t\t<id>1</id>\n\t\t<name>CI Name</name>\n\t\t<description>description</description>\n\t\t<expected_delivery_time>1 day</expected_delivery_time>\n\t\t<currency>USD</currency>\n\t\t<price>1</price>\n\t\t<show_price>true</show_price>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<category>\n\t\t\t<id>1</id>\n\t\t\t<name>Category / Subcategory name</name>\n\t\t\t<default_tags>tag1, tag2</default_tags>\n\t\t\t<parent_id>1</parent_id>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t\t<deleted>true</deleted>\n\t\t</category>\n\t\t<subcategory>\n\t\t\t<id>1</id>\n\t\t\t<name>Category / Subcategory name</name>\n\t\t\t<default_tags>tag1, tag2</default_tags>\n\t\t\t<parent_id>1</parent_id>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t\t<deleted>true</deleted>\n\t\t</subcategory>\n\t\t<origin>api</origin>\n\t</catalog_item>\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}]},"default_group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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","default_group_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}]},"default_group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","anyOf":[{"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":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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>\n\t<name>CI Name</name>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<description>description</description>\n\t<state>Approved</state>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<category>\n\t\t<name>Object Name</name>\n\t</category>\n\t<subcategory>\n\t\t<name>Object Name</name>\n\t</subcategory>\n\t<expected_delivery_time>1 day</expected_delivery_time>\n\t<currency>USD</currency>\n\t<price>1</price>\n\t<show_price>1</show_price>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n</catalog_item>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"origin":{"type":"string","example":"api"}}}}},"example":"<catalog_item>\n\t<id>1</id>\n\t<name>CI Name</name>\n\t<description>description</description>\n\t<expected_delivery_time>1 day</expected_delivery_time>\n\t<currency>USD</currency>\n\t<price>1</price>\n\t<show_price>true</show_price>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<category>\n\t\t<id>1</id>\n\t\t<name>Category / Subcategory name</name>\n\t\t<default_tags>tag1, tag2</default_tags>\n\t\t<parent_id>1</parent_id>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t<deleted>true</deleted>\n\t</category>\n\t<subcategory>\n\t\t<id>1</id>\n\t\t<name>Category / Subcategory name</name>\n\t\t<default_tags>tag1, tag2</default_tags>\n\t\t<parent_id>1</parent_id>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t<deleted>true</deleted>\n\t</subcategory>\n\t<origin>api</origin>\n</catalog_item>"}}},"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"},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}},"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","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":{"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"},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}},"example":"<incident>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<requester_name>john.doe@email.com</requester_name>\n\t<priority>High</priority>\n\t<due_at>Jan 01,2025</due_at>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</incident>"}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","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":{"id":10000,"number":1000,"name":"Incident Name","description":"<p>description</p>","description_no_html":"description","state":"New","priority":"High","category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"sub_category":{"id":1000,"name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"assignee":{"group_id":1,"is_user":"true","id":1,"name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"group_assignee":{"id":1,"name":"Helpdesk Team","disabled":false,"is_user":false,"avatar":{"type":"group","color":"#2eabcf","klass":"RealGroup"},"reports_to":{"id":1,"avatar":null,"name":"Super Manager"},"type":"RealGroup","send_notifications":true,"memberships":[{"id":11,"type":"User","user":"John Doe"}]},"requester":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"created_at":"2024-01-01T00:00:00.000+01:00","updated_at":"2024-01-01T00:00:00.000+01:00","due_at":"2025-01-01T00:00:00.000+01:00","sla_violations":[{"id":1000,"name":"SLA0001","sla_id":289,"sla_type":"not_commented","resolved":false,"time_delay":1,"time_units":"minutes","assignee":{"id":1,"name":"John Doe"},"group_assignee":{"id":1,"name":"Network Team"}}],"number_of_comments":0,"user_saw_all_comments":true,"is_service_request":false,"created_by":{"id":1,"account_id":1,"user_id":1,"email":"john.doe@email.com","name":"John Doe","disabled":false,"has_gravatar":false,"customer_satisfaction_survey_time":"2023-01-01T00:00:00.000-04:00","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"resolved_by":{"id":1,"name":"John Doe","disabled":false,"title":"title","email":"john.doe@email.com","created_at":"2023-01-01T00:00:00.000-00:00","updated_at":"2023-01-01T00:00:00.000-00:00","last_login":"2023-01-01T00:00:00.000-00:00","phone":"0123-456-789","mobile_phone":"0987-654-321","role":{"id":1,"name":"Administrator","description":"description","portal":false,"show_my_tasks":false},"group_ids":[1],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"provider","custom_fields_values":[],"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{}},"resolution_description":"description","resolution_code":"Done","customer_satisfaction_survey_sent_at":"2020-01-01T00:00:00.000-00:00","customer_satisfaction_survey_completed_at":"2020-01-01T00:00:00.000-00:00","custom":"2020-01-01 00:00:00.000","href":"http://mydomain.com/incidents/100","href_account_domain":"http://mydomain.com/incidents/100","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"cc":["jane.doe@email.com"],"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"}}],"origin":"api","price":"1234.00 USD","releases":[{"id":100,"href":"https://mydomain.com/releases/100"}],"problems":[{"id":100,"href":"https://mydomain.com/problems/100"}],"incidents":[{"id":100,"href":"https://mydomain.com/incidents/100"}],"changes":[{"id":100,"href":"https://mydomain.com/changes/100"}],"tasks":[{"id":100,"href":"https://mydomain.com/incidents/100/tasks/100"}],"time_tracks":[{"id":100,"href":"https://mydomain.com/incidents/100/time_tracks/100"}],"solutions":[{"id":100,"href":"https://mydomain.com/solutions/100"}],"assets":[{"id":100,"href":"https://mydomain.com/hardwares/100"}],"mobiles":[{"id":100,"href":"https://mydomain.com/mobiles/100"}],"other_assets":[{"id":100,"href":"https://mydomain.com/other_assets/100"}],"configuration_items":[{"id":100,"href":"https://mydomain.com/configuration_items/100"}],"discovery_hardware":[{"id":100,"href":"https://mydomain.com/descovery_hardwares/100"}],"purchase_orders":[{"id":100,"href":"https://mydomain.com/purchase_orders/100"}]}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"integer","example":1},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"description_no_html":{"type":"string","example":"description"},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"deleted":{"type":"boolean","example":false}}},"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"}}}}},"group_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"type":"string","example":"false"},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"description":{"type":"string","example":"John Doe"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"user":{"type":"string","example":"John Doe"},"type":{"type":"string","example":"User"}}}}}},"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"}}}}},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"due_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"sla_violations":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SLA001"},"sla_id":{"type":"integer","example":1},"sla_type":{"type":"string","example":"not_commented"},"resolved":{"type":"boolean","example":false},"time_delay":{"type":"integer","example":1},"time_units":{"type":"string","example":"minutes"},"assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"}}},"group_assignee":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Network team"}}}}}},"number_of_comments":{"type":"integer","example":0},"user_saw_all_comments":{"type":"boolean","example":false},"is_service_request":{"type":"boolean","example":true},"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"}}}}},"resolved_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"title":{"type":"string","example":"title"},"email":{"type":"string","example":"john.doe@email.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"updated_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"last_login":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"phone":{"type":"string","example":"0123-456-789"},"mobile_phone":{"type":"string","example":"0123-456-789"},"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}}},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"available_for_assignment":{"type":"boolean","example":false},"can_be_available_for_assignment":{"type":"boolean","example":false},"provider":{"type":"string","example":"provider"},"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"}}}},"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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"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"}}}}}}},"resolution_description":{"type":"string","example":"description"},"resolution_code":{"type":"string","example":"Done"},"customer_satisfaction_survey_sent_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"customer_satisfaction_survey_completed_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"},"custom":{"type":"string","example":"2023-01-01 00:00:00.000"},"href":{"type":"string","example":"https://mydomain.com/object_type/1"},"href_account_domain":{"type":"string","example":"https://mydomain.com/object_type/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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","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: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""},"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"}}}},"origin":{"type":"string","example":"api"},"price":{"type":"string","example":"1234.00 USD","description":"(Only For service requests)"},"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"}}}},"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"}}}},"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"}}}},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"time_tracks":{"type":"array","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"}}}},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"mobiles":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"other_assets":{"type":"array","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"}}}},"discovery_hardware":{"type":"array","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_order":{"type":"array","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":"<id>1</id>\n<number>1</number>\n<name>Incident Name</name>\n<description>description</description>\n<description_no_html>description</description_no_html>\n<state>New</state>\n<priority>High</priority>\n<category>\n\t<id>1</id>\n\t<name>Category / Subcategory name</name>\n\t<default_tags>tag1, tag2</default_tags>\n\t<parent_id>1</parent_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<deleted>true</deleted>\n</category>\n<subcategory>\n\t<id>1</id>\n\t<name>Category / Subcategory name</name>\n\t<default_tags>tag1, tag2</default_tags>\n\t<parent_id>1</parent_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<deleted>true</deleted>\n</subcategory>\n<assignee>\n\t<group_id>1</group_id>\n\t<is_user>true</is_user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<email>john.doe@email.com</email>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</assignee>\n<group_assignee>\n\t<group_id>1</group_id>\n\t<is_user>false</is_user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<description>John Doe</description>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</group_assignee>\n<requester>\n\t<id>1</id>\n\t<account_id>1</account_id>\n\t<user_id>1</user_id>\n\t<email>john.doe@email.com</email>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</requester>\n<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n<due_at>2020-01-01T00:00:00.000+00:00</due_at>\n<number_of_comments>0</number_of_comments>\n<user_saw_all_comments>true</user_saw_all_comments>\n<is_service_request>true</is_service_request>\n<created_by>\n\t<id>1</id>\n\t<account_id>1</account_id>\n\t<user_id>1</user_id>\n\t<email>john.doe@email.com</email>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n</created_by>\n<resolved_by>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<disabled>true</disabled>\n\t<title>title</title>\n\t<email>john.doe@email.com</email>\n\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n\t<updated_at>2020-01-01T00:00:00.000+00:00</updated_at>\n\t<last_login>2020-01-01T00:00:00.000+00:00</last_login>\n\t<phone>0123-456-789</phone>\n\t<mobile_phone>0123-456-789</mobile_phone>\n\t<role>\n\t\t<id>1</id>\n\t\t<name>Requester</name>\n\t\t<description>Requester role</description>\n\t\t<portal>true</portal>\n\t\t<show_my_tasks>true</show_my_tasks>\n\t</role>\n\t<available_for_assignment>true</available_for_assignment>\n\t<can_be_available_for_assignment>true</can_be_available_for_assignment>\n\t<provider>provider</provider>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n</resolved_by>\n<resolution_description>description</resolution_description>\n<resolution_code>Done</resolution_code>\n<customer_satisfaction_survey_sent_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_sent_at>\n<customer_satisfaction_survey_completed_at>2020-01-01T00:00:00.000+00:00</customer_satisfaction_survey_completed_at>\n<custom>2023-01-01 00:00:00.000</custom>\n<href>https://mydomain.com/object_type/1</href>\n<href_account_domain>https://mydomain.com/object_type/1</href_account_domain>\n<site>\n\t<id>1</id>\n\t<name>Austin TX, USA</name>\n\t<description>AUS</description>\n\t<location>AUS</location>\n\t<timezone>UTC-6h</timezone>\n</site>\n<department>\n\t<id>1</id>\n\t<name>Support</name>\n\t<description>Support Department</description>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n</department>\n<origin>api</origin>\n<price>1234.00 USD</price>"}}},"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}]},"default_group_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"}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/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}]},"default_group_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"}}}},"origin":{"type":"string","example":"api"}}}}},"example":"<configuration_item>\n\t<id>1</id>\n\t<name>CI Name</name>\n\t<description>description</description>\n\t<type>\n\t\t<id>1</id>\n\t\t<name>Building</name>\n\t\t<description>Configuration Item - Building</description>\n\t\t<parent_id>1</parent_id>\n\t\t<custom>true</custom>\n\t\t<icon_name>BUILDING</icon_name>\n\t\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t</type>\n\t<type_id>1</type_id>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>Active</state>\n\t<manager_id>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</manager_id>\n\t<user_id>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user_id>\n\t<origin>api</origin>\n</configuration_item>"}}},"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","anyOf":[{"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","nullable":true,"example":"string"},"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"user":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"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],"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"configuration_item":{"type":"object","properties":{"type":{"type":"object","anyOf":[{"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","nullable":true,"example":"string"},"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"user":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":"<configuration_item>\n\t<type>\n\t\t<name>Object Name</name>\n\t</type>\n\t<type_id>1</type_id>\n\t<name>CI Name</name>\n\t<description>string</description>\n\t<asset_tag>Configuration Item Tag</asset_tag>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>Active</state>\n\t<manager>\n\t\t<email>john.doe@email.com</email>\n\t</manager>\n\t<user>\n\t\t<email>john.doe@email.com</email>\n\t</user>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</configuration_item>"}}},"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}]},"default_group_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"}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/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}]},"default_group_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"}}}},"origin":{"type":"string","example":"api"}}}}},"example":"<configuration_item>\n\t<id>1</id>\n\t<name>CI Name</name>\n\t<description>description</description>\n\t<type>\n\t\t<id>1</id>\n\t\t<name>Building</name>\n\t\t<description>Configuration Item - Building</description>\n\t\t<parent_id>1</parent_id>\n\t\t<custom>true</custom>\n\t\t<icon_name>BUILDING</icon_name>\n\t\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t</type>\n\t<type_id>1</type_id>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>Active</state>\n\t<manager_id>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</manager_id>\n\t<user_id>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user_id>\n\t<origin>api</origin>\n</configuration_item>"}}},"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}]},"default_group_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"}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/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}]},"default_group_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"}}}},"origin":{"type":"string","example":"api"}}}}}},"example":"<>\n\t<configuration_item>\n\t\t<id>1</id>\n\t\t<name>CI Name</name>\n\t\t<description>description</description>\n\t\t<type>\n\t\t\t<id>1</id>\n\t\t\t<name>Building</name>\n\t\t\t<description>Configuration Item - Building</description>\n\t\t\t<parent_id>1</parent_id>\n\t\t\t<custom>true</custom>\n\t\t\t<icon_name>BUILDING</icon_name>\n\t\t\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t\t</type>\n\t\t<type_id>1</type_id>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<state>Active</state>\n\t\t<manager_id>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</manager_id>\n\t\t<user_id>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</user_id>\n\t\t<origin>api</origin>\n\t</configuration_item>\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","anyOf":[{"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","nullable":true,"example":"string"},"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"user":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"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],"incidents":[{"number":100}],"problems":[{"number":100}],"changes":[{"number":100}],"solutions":[{"number":100}],"releases":[{"number":100}],"purchase_orders":[{"number":100}],"configuration_items":[{"name":"Item name"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"configuration_item":{"type":"object","required":["name"],"properties":{"type":{"type":"object","anyOf":[{"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","nullable":true,"example":"string"},"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"user":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":"<configuration_item>\n\t<type>\n\t\t<name>Object Name</name>\n\t</type>\n\t<type_id>1</type_id>\n\t<name>CI Name</name>\n\t<description>string</description>\n\t<asset_tag>Configuration Item Tag</asset_tag>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<state>Active</state>\n\t<manager>\n\t\t<email>john.doe@email.com</email>\n\t</manager>\n\t<user>\n\t\t<email>john.doe@email.com</email>\n\t</user>\n\t<add_to_tag_list>tag1, tag2</add_to_tag_list>\n\t<remove_from_tag_list>tag3</remove_from_tag_list>\n\t<tag_list>tag1, tag2</tag_list>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</configuration_item>"}}},"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}]},"default_group_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"}}}},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/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}]},"default_group_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"}}}},"origin":{"type":"string","example":"api"}}}}},"example":"<configuration_item>\n\t<id>1</id>\n\t<name>CI Name</name>\n\t<description>description</description>\n\t<type>\n\t\t<id>1</id>\n\t\t<name>Building</name>\n\t\t<description>Configuration Item - Building</description>\n\t\t<parent_id>1</parent_id>\n\t\t<custom>true</custom>\n\t\t<icon_name>BUILDING</icon_name>\n\t\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t</type>\n\t<type_id>1</type_id>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<state>Active</state>\n\t<manager_id>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</manager_id>\n\t<user_id>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user_id>\n\t<origin>api</origin>\n</configuration_item>"}}},"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":"<assetLinkId>1</assetLinkId>\n<sourceId>1</sourceId>\n<sourceType>ConfigurationItem</sourceType>"}}},"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}]},"default_group_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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}},"example":"<user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<title>Support Agent</title>\n\t<email>john.doe@email.com</email>\n\t<phone>+10000000</phone>\n\t<mobile_phone>+10000000</mobile_phone>\n\t<role>\n\t\t<id>1</id>\n\t\t<name>Requester</name>\n\t\t<description>Requester role</description>\n\t\t<portal>true</portal>\n\t\t<show_my_tasks>true</show_my_tasks>\n\t</role>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n</user>"}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"reports_to":{"anyOf":[{"type":"object","required":["id"],"properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}}}}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"reports_to":{"anyOf":[{"type":"object","required":["id"],"properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}}}}}},"example":"<user>\n\t<name>John Doe</name>\n\t<title>Support Agent</title>\n\t<email>john.doe@email.com</email>\n\t<disabled>true</disabled>\n\t<phone>+10000000</phone>\n\t<mobile_phone>+10000000</mobile_phone>\n\t<role>\n\t\t<name>Object Name</name>\n\t</role>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<reports_to>1</reports_to>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n</user>"}}},"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}]},"default_group_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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}},"example":"<user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<title>Support Agent</title>\n\t<email>john.doe@email.com</email>\n\t<phone>+10000000</phone>\n\t<mobile_phone>+10000000</mobile_phone>\n\t<role>\n\t\t<id>1</id>\n\t\t<name>Requester</name>\n\t\t<description>Requester role</description>\n\t\t<portal>true</portal>\n\t\t<show_my_tasks>true</show_my_tasks>\n\t</role>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n</user>"}}},"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}]},"default_group_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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}}},"example":"<>\n\t<user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<title>Support Agent</title>\n\t\t<email>john.doe@email.com</email>\n\t\t<phone>+10000000</phone>\n\t\t<mobile_phone>+10000000</mobile_phone>\n\t\t<role>\n\t\t\t<id>1</id>\n\t\t\t<name>Requester</name>\n\t\t\t<description>Requester role</description>\n\t\t\t<portal>true</portal>\n\t\t\t<show_my_tasks>true</show_my_tasks>\n\t\t</role>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t\t<reports_to>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</reports_to>\n\t\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n\t</user>\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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"reports_to":{"anyOf":[{"type":"object","required":["id"],"properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}}}}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"reports_to":{"anyOf":[{"type":"object","required":["id"],"properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}}}}}},"example":"<user>\n\t<name>John Doe</name>\n\t<title>Support Agent</title>\n\t<email>john.doe@email.com</email>\n\t<disabled>true</disabled>\n\t<phone>+10000000</phone>\n\t<mobile_phone>+10000000</mobile_phone>\n\t<role>\n\t\t<name>Object Name</name>\n\t</role>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<reports_to>1</reports_to>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n</user>"}}},"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}]},"default_group_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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}},"example":"<user>\n\t<id>1</id>\n\t<name>John Doe</name>\n\t<title>Support Agent</title>\n\t<email>john.doe@email.com</email>\n\t<phone>+10000000</phone>\n\t<mobile_phone>+10000000</mobile_phone>\n\t<role>\n\t\t<id>1</id>\n\t\t<name>Requester</name>\n\t\t<description>Requester role</description>\n\t\t<portal>true</portal>\n\t\t<show_my_tasks>true</show_my_tasks>\n\t</role>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n\t<created_at>2020-01-01T00:00:00.000+00:00</created_at>\n</user>"}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<site>\n\t<id>1</id>\n\t<name>Austin TX, USA</name>\n\t<location>AUS</location>\n\t<description>Description Austin TX, USA</description>\n\t<time_zone>Texas</time_zone>\n\t<language>en</language>\n\t<business_record>1</business_record>\n\t<default_assignee>1</default_assignee>\n\t<default_group_assignee>1</default_group_assignee>\n</site>"}}},"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":{"anyOf":[{"type":"string","example":"Description Austin TX, USA"},{"nullable":true}]},"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}]},"default_group_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":{"anyOf":[{"type":"string","example":"Description Austin TX, USA"},{"nullable":true}]},"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}]},"default_group_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":"<site>\n\t<name>Austin TX, USA</name>\n\t<location>AUS</location>\n\t<description>Description Austin TX, USA</description>\n\t<time_zone>Texas</time_zone>\n\t<language>en</language>\n\t<manager_id>1</manager_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<business_record>\n\t\t<id>1</id>\n\t</business_record>\n</site>"}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<site>\n\t<id>1</id>\n\t<name>Austin TX, USA</name>\n\t<location>AUS</location>\n\t<description>Description Austin TX, USA</description>\n\t<time_zone>Texas</time_zone>\n\t<language>en</language>\n\t<business_record>1</business_record>\n\t<default_assignee>1</default_assignee>\n\t<default_group_assignee>1</default_group_assignee>\n</site>"}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"example":"<>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<location>AUS</location>\n\t\t<description>Description Austin TX, USA</description>\n\t\t<time_zone>Texas</time_zone>\n\t\t<language>en</language>\n\t\t<business_record>1</business_record>\n\t\t<default_assignee>1</default_assignee>\n\t\t<default_group_assignee>1</default_group_assignee>\n\t</site>\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":{"anyOf":[{"type":"string","example":"Description Austin TX, USA"},{"nullable":true}]},"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}]},"default_group_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":{"anyOf":[{"type":"string","example":"Description Austin TX, USA"},{"nullable":true}]},"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}]},"default_group_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":"<site>\n\t<name>Austin TX, USA</name>\n\t<location>AUS</location>\n\t<description>Description Austin TX, USA</description>\n\t<time_zone>Texas</time_zone>\n\t<language>en</language>\n\t<manager_id>1</manager_id>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<business_record>\n\t\t<id>1</id>\n\t</business_record>\n</site>"}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<site>\n\t<id>1</id>\n\t<name>Austin TX, USA</name>\n\t<location>AUS</location>\n\t<description>Description Austin TX, USA</description>\n\t<time_zone>Texas</time_zone>\n\t<language>en</language>\n\t<business_record>1</business_record>\n\t<default_assignee>1</default_assignee>\n\t<default_group_assignee>1</default_group_assignee>\n</site>"}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<department>\n\t<id>1</id>\n\t<name>Support</name>\n\t<description>Support Department</description>\n\t<default_assignee>1</default_assignee>\n\t<default_group_assignee>1</default_group_assignee>\n</department>"}}},"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":{"anyOf":[{"type":"string","example":"Support Department"},{"nullable":true}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"department":{"type":"object","properties":{"name":{"type":"string","example":"Support"},"description":{"anyOf":[{"type":"string","example":"Support Department"},{"nullable":true}]}}}}},"example":"<department>\n\t<name>Support</name>\n\t<description>Support Department</description>\n</department>"}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<department>\n\t<id>1</id>\n\t<name>Support</name>\n\t<description>Support Department</description>\n\t<default_assignee>1</default_assignee>\n\t<default_group_assignee>1</default_group_assignee>\n</department>"}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}]}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"example":"<>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee>1</default_assignee>\n\t\t<default_group_assignee>1</default_group_assignee>\n\t</department>\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":{"anyOf":[{"type":"string","example":"Support Department"},{"nullable":true}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"department":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Support"},"description":{"anyOf":[{"type":"string","example":"Support Department"},{"nullable":true}]}}}}},"example":"<department>\n\t<name>Support</name>\n\t<description>Support Department</description>\n</department>"}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"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"},"default_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_group_assignee":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<department>\n\t<id>1</id>\n\t<name>Support</name>\n\t<description>Support Department</description>\n\t<default_assignee>1</default_assignee>\n\t<default_group_assignee>1</default_group_assignee>\n</department>"}}},"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":"<role>\n\t<id>1</id>\n\t<name>Support Agent</name>\n\t<description>Support Agent role</description>\n\t<portal>true</portal>\n\t<show_my_tasks>true</show_my_tasks>\n</role>"}}},"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":"<role>\n\t<name>Support Agent</name>\n\t<description>Support Agent role</description>\n\t<portal>true</portal>\n</role>"}}},"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":"<role>\n\t<id>1</id>\n\t<name>Support Agent</name>\n\t<description>Support Agent role</description>\n\t<portal>true</portal>\n\t<show_my_tasks>true</show_my_tasks>\n</role>"}}},"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<role>\n\t\t<id>1</id>\n\t\t<name>Support Agent</name>\n\t\t<description>Support Agent role</description>\n\t\t<portal>true</portal>\n\t\t<show_my_tasks>true</show_my_tasks>\n\t</role>\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":"<role>\n\t<name>Support Agent</name>\n\t<description>Support Agent role</description>\n\t<portal>true</portal>\n</role>"}}},"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":"<role>\n\t<id>1</id>\n\t<name>Support Agent</name>\n\t<description>Support Agent role</description>\n\t<portal>true</portal>\n\t<show_my_tasks>true</show_my_tasks>\n</role>"}}},"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"}}}},"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":{"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"}}}},"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":"<group>\n\t<id>1</id>\n\t<name>Group Name</name>\n\t<description>Group Description</description>\n\t<is_user>true</is_user>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<send_notifications>true</send_notifications>\n</group>"}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}},"example":"<group>\n\t<name>Group Name</name>\n\t<description>Group Description</description>\n\t<superviser_id>1</superviser_id>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</group>"}}},"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"}}}},"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":{"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"}}}},"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":"<group>\n\t<id>1</id>\n\t<name>Group Name</name>\n\t<description>Group Description</description>\n\t<is_user>true</is_user>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<send_notifications>true</send_notifications>\n</group>"}}},"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"}}}},"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 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"}}}},"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<group>\n\t\t<id>1</id>\n\t\t<name>Group Name</name>\n\t\t<description>Group Description</description>\n\t\t<is_user>true</is_user>\n\t\t<reports_to>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</reports_to>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t\t<send_notifications>true</send_notifications>\n\t</group>\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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}},"example":"<group>\n\t<name>Group Name</name>\n\t<description>Group Description</description>\n\t<superviser_id>1</superviser_id>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</group>"}}},"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"}}}},"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":{"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"}}}},"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":"<group>\n\t<id>1</id>\n\t<name>Group Name</name>\n\t<description>Group Description</description>\n\t<is_user>true</is_user>\n\t<reports_to>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</reports_to>\n\t<avatar>\n\t\t<type>initials</type>\n\t\t<color>#1000</color>\n\t\t<initials>JD</initials>\n\t</avatar>\n\t<send_notifications>true</send_notifications>\n</group>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<category>\n\t<id>1</id>\n\t<name>Equipment</name>\n\t<parent_id>1</parent_id>\n\t<default_tags>equipment</default_tags>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n</category>"}}},"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","anyOf":[{"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_group_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","anyOf":[{"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_group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"}}}}},"example":"<category>\n\t<name>Equipment</name>\n\t<parent>\n\t\t<name>Object Name</name>\n\t</parent>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<default_tags>equipment</default_tags>\n</category>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<category>\n\t<id>1</id>\n\t<name>Equipment</name>\n\t<parent_id>1</parent_id>\n\t<default_tags>equipment</default_tags>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n</category>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"example":"<>\n\t<category>\n\t\t<id>1</id>\n\t\t<name>Equipment</name>\n\t\t<parent_id>1</parent_id>\n\t\t<default_tags>equipment</default_tags>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</category>\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","anyOf":[{"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_group_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","anyOf":[{"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_group_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"}}}}},"example":"<category>\n\t<name>Equipment</name>\n\t<parent>\n\t\t<name>Object Name</name>\n\t</parent>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n\t<default_tags>equipment</default_tags>\n</category>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<category>\n\t<id>1</id>\n\t<name>Equipment</name>\n\t<parent_id>1</parent_id>\n\t<default_tags>equipment</default_tags>\n\t<default_assignee_id>1</default_assignee_id>\n\t<default_group_assignee_id>1</default_group_assignee_id>\n</category>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the hardwares","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as contract, purchase, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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"}}}}},"examples":{"layout=short":{"value":{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}}},"layout=long":{"value":{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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","contract":null,"maintenance_contract":null,"lease_contract":{"href":"https://api.samanage.com/contracts/476738-eetay-s-contract","id":476738,"name":"Eetay's contract","type":"Lease","manufacturer_name":"Microsoft","start_date":"2018-07-10T17:00:00.000-07:00","end_date":"2018-09-29T17:00:00.000-07:00","created_at":"2018-07-10T04:19:38.000-07:00","updated_at":"2024-08-27T02:19:54.000-07:00","note":"","site":null,"department":null,"items":[{"name":"Apple - iPhone 7","version":null,"quantity":1,"language":null,"date":null,"rate":null,"notes":null,"created_at":"2018-08-23T04:56:30.000-07:00","updated_at":"2019-08-20T01:52:09.000-07:00","tag":null,"manufacturer":null,"contract":null,"inventory":null,"variance":null}],"status":"Active","custom_fields_values":[{"id":62973780,"custom_field_id":21442,"name":"Scott User","value":"-1","attachment":null,"options":"","type":7,"type_name":"User","entity":null,"user":null}]},"lease_expiration":null,"purchase":{"id":266650,"date":"2024-08-26T00:00:00.000-07:00","number":"1","notes":"","total_cost":"10.0","currency":"USD","recurrence":"One_Time","created_at":"2024-08-27T02:20:19.000-07:00","updated_at":"2024-08-27T02:20:19.000-07:00","vendor":{"id":153707,"href":"https://api.samanage.com/vendors/153707-amazon","name":"Amazon","url":"","contact_name":"","contact_email":"","contact_phone":"","note":"","address":"","city":"","state":"","zip":"","telephone":"","vendor_type":{"id":50,"name":"Computer Hardware Vendor"}}},"hardware_dates":[{"id":163580672,"date":"2024-08-22","date_type":"Assigned","username":null,"notes":"[Automatic] Assigned to Brazil site","user_type":null}],"attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"}]}}}}},"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}]},"default_group_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>\n\t<id>1</id>\n\t<name>Hardware Name</name>\n\t<ip>0.0.0.0</ip>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<category>\n\t\t<id>1</id>\n\t\t<name>Laptop</name>\n\t</category>\n\t<owner>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</owner>\n\t<technical_contact>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</technical_contact>\n\t<notes>Hardware notes</notes>\n\t<barcode_encoding_format>Code1A</barcode_encoding_format>\n\t<cpu>hardware_cpu</cpu>\n\t<processor_speed>processor_speed</processor_speed>\n\t<memory>1024</memory>\n\t<swap>MB</swap>\n\t<domain>domain description</domain>\n\t<operating_system>Windows 10</operating_system>\n\t<active_directory>Workgroup of the OS</active_directory>\n\t<address>Site 1, Building 1, Department 1</address>\n\t<longitude>0.000</longitude>\n\t<latitude>0.000</latitude>\n\t<product_number>1</product_number>\n\t<tag>hardware tag</tag>\n\t<asset_tag>1</asset_tag>\n</hardware>"}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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>\n\t<name>Hardware Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<category>\n\t\t<name>Object Name</name>\n\t</category>\n\t<ip_address>0.0.0.0</ip_address>\n\t<external_ip>0.0.0.0</external_ip>\n\t<status>\n\t\t<name>Object Name</name>\n\t</status>\n\t<technical_contact>\n\t\t<email>john.doe@email.com</email>\n\t</technical_contact>\n\t<owner>\n\t\t<email>john.doe@email.com</email>\n\t</owner>\n\t<notes>Hardware notes</notes>\n\t<barcode_encoding_format>Code1A</barcode_encoding_format>\n\t<cpu>hardware_cpu</cpu>\n\t<memory>1024</memory>\n\t<swap>MB</swap>\n\t<domain>domain description</domain>\n\t<operating_system>Windows 10</operating_system>\n\t<active_directory>Workgroup of the OS</active_directory>\n\t<address>Site 1, Building 1, Department 1</address>\n\t<longitude>0.000</longitude>\n\t<latitude>0.000</latitude>\n\t<product_number>1</product_number>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<bio>\n\t\t<manufacturer>Dell</manufacturer>\n\t\t<ssn>1</ssn>\n\t\t<model>model description</model>\n\t\t<version>1</version>\n\t\t<bios_date>2020-01-01 00:00</bios_date>\n\t</bio>\n\t<tag>hardware tag</tag>\n\t<asset_tag>1</asset_tag>\n</hardware>"}}},"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}]},"default_group_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":{"json":{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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>\n\t<id>1</id>\n\t<name>Hardware Name</name>\n\t<ip>0.0.0.0</ip>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<category>\n\t\t<id>1</id>\n\t\t<name>Laptop</name>\n\t</category>\n\t<owner>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</owner>\n\t<technical_contact>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</technical_contact>\n\t<notes>Hardware notes</notes>\n\t<barcode_encoding_format>Code1A</barcode_encoding_format>\n\t<cpu>hardware_cpu</cpu>\n\t<processor_speed>processor_speed</processor_speed>\n\t<memory>1024</memory>\n\t<swap>MB</swap>\n\t<domain>domain description</domain>\n\t<operating_system>Windows 10</operating_system>\n\t<active_directory>Workgroup of the OS</active_directory>\n\t<address>Site 1, Building 1, Department 1</address>\n\t<longitude>0.000</longitude>\n\t<latitude>0.000</latitude>\n\t<product_number>1</product_number>\n\t<tag>hardware tag</tag>\n\t<asset_tag>1</asset_tag>\n</hardware>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the hardwares","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as contract, purchase, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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"}}}}}},"examples":{"layout=short":{"value":[{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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"}}]},"layout=long":{"value":[{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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","contract":null,"maintenance_contract":null,"lease_contract":{"href":"https://api.samanage.com/contracts/476738-eetay-s-contract","id":476738,"name":"Eetay's contract","type":"Lease","manufacturer_name":"Microsoft","start_date":"2018-07-10T17:00:00.000-07:00","end_date":"2018-09-29T17:00:00.000-07:00","created_at":"2018-07-10T04:19:38.000-07:00","updated_at":"2024-08-27T02:19:54.000-07:00","note":"","site":null,"department":null,"items":[{"name":"Apple - iPhone 7","version":null,"quantity":1,"language":null,"date":null,"rate":null,"notes":null,"created_at":"2018-08-23T04:56:30.000-07:00","updated_at":"2019-08-20T01:52:09.000-07:00","tag":null,"manufacturer":null,"contract":null,"inventory":null,"variance":null}],"status":"Active","custom_fields_values":[{"id":62973780,"custom_field_id":21442,"name":"Scott User","value":"-1","attachment":null,"options":"","type":7,"type_name":"User","entity":null,"user":null}]},"lease_expiration":null,"purchase":{"id":266650,"date":"2024-08-26T00:00:00.000-07:00","number":"1","notes":"","total_cost":"10.0","currency":"USD","recurrence":"One_Time","created_at":"2024-08-27T02:20:19.000-07:00","updated_at":"2024-08-27T02:20:19.000-07:00","vendor":{"id":153707,"href":"https://api.samanage.com/vendors/153707-amazon","name":"Amazon","url":"","contact_name":"","contact_email":"","contact_phone":"","note":"","address":"","city":"","state":"","zip":"","telephone":"","vendor_type":{"id":50,"name":"Computer Hardware Vendor"}}},"hardware_dates":[{"id":163580672,"date":"2024-08-22","date_type":"Assigned","username":null,"notes":"[Automatic] Assigned to Brazil site","user_type":null}],"attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"}]}}]}}},"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}]},"default_group_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<hardware>\n\t\t<id>1</id>\n\t\t<name>Hardware Name</name>\n\t\t<ip>0.0.0.0</ip>\n\t\t<description>description</description>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<status>Operational</status>\n\t\t<category>\n\t\t\t<id>1</id>\n\t\t\t<name>Laptop</name>\n\t\t</category>\n\t\t<owner>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</owner>\n\t\t<technical_contact>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</technical_contact>\n\t\t<notes>Hardware notes</notes>\n\t\t<barcode_encoding_format>Code1A</barcode_encoding_format>\n\t\t<cpu>hardware_cpu</cpu>\n\t\t<processor_speed>processor_speed</processor_speed>\n\t\t<memory>1024</memory>\n\t\t<swap>MB</swap>\n\t\t<domain>domain description</domain>\n\t\t<operating_system>Windows 10</operating_system>\n\t\t<active_directory>Workgroup of the OS</active_directory>\n\t\t<address>Site 1, Building 1, Department 1</address>\n\t\t<longitude>0.000</longitude>\n\t\t<latitude>0.000</latitude>\n\t\t<product_number>1</product_number>\n\t\t<tag>hardware tag</tag>\n\t\t<asset_tag>1</asset_tag>\n\t</hardware>\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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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>\n\t<name>Hardware Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<category>\n\t\t<name>Object Name</name>\n\t</category>\n\t<ip_address>0.0.0.0</ip_address>\n\t<external_ip>0.0.0.0</external_ip>\n\t<status>\n\t\t<name>Object Name</name>\n\t</status>\n\t<technical_contact>\n\t\t<email>john.doe@email.com</email>\n\t</technical_contact>\n\t<owner>\n\t\t<email>john.doe@email.com</email>\n\t</owner>\n\t<notes>Hardware notes</notes>\n\t<barcode_encoding_format>Code1A</barcode_encoding_format>\n\t<cpu>hardware_cpu</cpu>\n\t<memory>1024</memory>\n\t<swap>MB</swap>\n\t<domain>domain description</domain>\n\t<operating_system>Windows 10</operating_system>\n\t<active_directory>Workgroup of the OS</active_directory>\n\t<address>Site 1, Building 1, Department 1</address>\n\t<longitude>0.000</longitude>\n\t<latitude>0.000</latitude>\n\t<product_number>1</product_number>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<bio>\n\t\t<manufacturer>Dell</manufacturer>\n\t\t<ssn>1</ssn>\n\t\t<model>model description</model>\n\t\t<version>1</version>\n\t\t<bios_date>2020-01-01 00:00</bios_date>\n\t</bio>\n\t<tag>hardware tag</tag>\n\t<asset_tag>1</asset_tag>\n</hardware>"}}},"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}]},"default_group_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":{"json":{"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":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_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}]},"default_group_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>\n\t<id>1</id>\n\t<name>Hardware Name</name>\n\t<ip>0.0.0.0</ip>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<category>\n\t\t<id>1</id>\n\t\t<name>Laptop</name>\n\t</category>\n\t<owner>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</owner>\n\t<technical_contact>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</technical_contact>\n\t<notes>Hardware notes</notes>\n\t<barcode_encoding_format>Code1A</barcode_encoding_format>\n\t<cpu>hardware_cpu</cpu>\n\t<processor_speed>processor_speed</processor_speed>\n\t<memory>1024</memory>\n\t<swap>MB</swap>\n\t<domain>domain description</domain>\n\t<operating_system>Windows 10</operating_system>\n\t<active_directory>Workgroup of the OS</active_directory>\n\t<address>Site 1, Building 1, Department 1</address>\n\t<longitude>0.000</longitude>\n\t<latitude>0.000</latitude>\n\t<product_number>1</product_number>\n\t<tag>hardware tag</tag>\n\t<asset_tag>1</asset_tag>\n</hardware>"}}},"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}]},"default_group_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"}}}}},"phone_number":{"type":"string","example":"12345"},"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}]},"default_group_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"}}}}},"phone_number":{"type":"string","example":"12345"},"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":"<mobile>\n\t<id>1</id>\n\t<name>Apple 1</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<device_type>Mobile Device</device_type>\n\t<manufacturer>Apple</manufacturer>\n\t<model>1</model>\n\t<company_issued>true</company_issued>\n\t<serial_number>1</serial_number>\n\t<imei>1</imei>\n\t<user>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user>\n\t<technical_contact>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</technical_contact>\n\t<phone_number>12345</phone_number>\n</mobile>"}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"phone_number":{"anyOf":[{"type":"string","example":"12345"},{"type":"integer","example":12345}]},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"mobile":{"type":"object","properties":{"description":{"type":"string","example":"description"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"phone_number":{"anyOf":[{"type":"string","example":"12345"},{"type":"integer","example":12345}]},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}},"example":"<mobile>\n\t<description>description</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<status>\n\t\t<name>Object Name</name>\n\t</status>\n\t<device_type>Mobile Device</device_type>\n\t<manufacturer>Apple</manufacturer>\n\t<model>1</model>\n\t<company_issued>true</company_issued>\n\t<serial_number>1</serial_number>\n\t<imei>1</imei>\n\t<user>\n\t\t<email>john.doe@email.com</email>\n\t</user>\n\t<technical_contact>\n\t\t<email>john.doe@email.com</email>\n\t</technical_contact>\n\t<phone_number>12345</phone_number>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</mobile>"}}},"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}]},"default_group_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"}}}}},"phone_number":{"type":"string","example":"12345"},"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}]},"default_group_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"}}}}},"phone_number":{"type":"string","example":"12345"},"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":"<mobile>\n\t<id>1</id>\n\t<name>Apple 1</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<device_type>Mobile Device</device_type>\n\t<manufacturer>Apple</manufacturer>\n\t<model>1</model>\n\t<company_issued>true</company_issued>\n\t<serial_number>1</serial_number>\n\t<imei>1</imei>\n\t<user>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user>\n\t<technical_contact>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</technical_contact>\n\t<phone_number>12345</phone_number>\n</mobile>"}}},"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}]},"default_group_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"}}}}},"phone_number":{"type":"string","example":"12345"},"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}]},"default_group_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"}}}}},"phone_number":{"type":"string","example":"12345"},"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<mobile>\n\t\t<id>1</id>\n\t\t<name>Apple 1</name>\n\t\t<description>description</description>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<status>Operational</status>\n\t\t<device_type>Mobile Device</device_type>\n\t\t<manufacturer>Apple</manufacturer>\n\t\t<model>1</model>\n\t\t<company_issued>true</company_issued>\n\t\t<serial_number>1</serial_number>\n\t\t<imei>1</imei>\n\t\t<user>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</user>\n\t\t<technical_contact>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</technical_contact>\n\t\t<phone_number>12345</phone_number>\n\t</mobile>\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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"phone_number":{"anyOf":[{"type":"string","example":"12345"},{"type":"integer","example":12345}]},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"phone_number":{"anyOf":[{"type":"string","example":"12345"},{"type":"integer","example":12345}]},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}},"example":"<mobile>\n\t<description>description</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<status>\n\t\t<name>Object Name</name>\n\t</status>\n\t<device_type>Mobile Device</device_type>\n\t<manufacturer>Apple</manufacturer>\n\t<model>1</model>\n\t<company_issued>true</company_issued>\n\t<serial_number>1</serial_number>\n\t<imei>1</imei>\n\t<user>\n\t\t<email>john.doe@email.com</email>\n\t</user>\n\t<technical_contact>\n\t\t<email>john.doe@email.com</email>\n\t</technical_contact>\n\t<phone_number>12345</phone_number>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</mobile>"}}},"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}]},"default_group_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"}}}}},"phone_number":{"type":"string","example":"12345"},"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}]},"default_group_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"}}}}},"phone_number":{"type":"string","example":"12345"},"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":"<mobile>\n\t<id>1</id>\n\t<name>Apple 1</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<device_type>Mobile Device</device_type>\n\t<manufacturer>Apple</manufacturer>\n\t<model>1</model>\n\t<company_issued>true</company_issued>\n\t<serial_number>1</serial_number>\n\t<imei>1</imei>\n\t<user>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user>\n\t<technical_contact>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</technical_contact>\n\t<phone_number>12345</phone_number>\n</mobile>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the other assets","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as image url, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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_address":{"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"}}}}}}}},"examples":{"layout=short":{"value":{"other_asset":{"custom":null,"id":"1","name":"Apple 1","owner":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#1000","initials":"JD"}},"user":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#1000","initials":"JD"}},"description":"description","asset_id":"1","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"asset_type":{"id":161656,"account_id":5,"parent_id":0,"name":"Charger"},"category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"ip_address":"0.0.0.0","manufacturer":"Apple","model":"1","serial_number":"1","created_at":"2024-08-27T03:46:18.000-07:00","updated_at":"2024-08-27T03:46:18.000-07:00","address":null,"tasks":[],"maintenance_contract":null,"lease_contract":null,"incidents":[],"purchase":null,"purchase_orders":[],"tags":[],"hardware_dates":[{"id":163900753,"date":"2024-08-27","date_type":"Assigned","username":"John Doe","notes":"[Automatic] Technical contact changed to John Doe","user_type":null}],"latitude":null,"longitude":null,"custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","type_name":"Text"}]}}},"layout=long":{"value":{"other_asset":{"custom":null,"id":"1","name":"Apple 1","owner":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#1000","initials":"JD"}},"user":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#1000","initials":"JD"}},"description":"description","asset_id":"1","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"asset_type":{"id":161656,"account_id":5,"parent_id":0,"name":"Charger"},"category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"status":{"id":1507926,"name":"Operational"},"ip_address":"0.0.0.0","manufacturer":"Apple","model":"1","serial_number":"1","created_at":"2024-08-27T03:46:18.000-07:00","updated_at":"2024-08-27T03:46:18.000-07:00","address":null,"tasks":[],"maintenance_contract":null,"lease_contract":null,"incidents":[],"purchase":null,"purchase_orders":[],"tags":[],"hardware_dates":[{"id":163900753,"date":"2024-08-27","date_type":"Assigned","username":"John Doe","notes":"[Automatic] Technical contact changed to John Doe","user_type":null}],"latitude":null,"longitude":null,"custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","type_name":"Text"}],"attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":true,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"},{"id":212598158,"content_type":"text/plain","size":251,"filename":"notpersonal.txt","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true","secure_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain","link_uuid_url":"/attachments/9d2e6444a7773cacab39","uuid":"9d2e6444a7773cacab39"}],"shared_attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","attachable_id":753657,"attachable_type":"Problem"}],"image_url":"https://mydomain.com/production.main.customer.data/images/959edaa5"}}}}},"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}]},"default_group_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_address":{"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":"<other_asset>\n\t<id>1</id>\n\t<name>Apple 1</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<asset_type>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<parent_id>1</parent_id>\n\t\t<name>Asset Type</name>\n\t</asset_type>\n\t<asset_id>1</asset_id>\n\t<manufacturer>Apple</manufacturer>\n\t<model>1</model>\n\t<ip_address>0.0.0.0</ip_address>\n\t<serial_number>1</serial_number>\n\t<user>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user>\n\t<owner>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</owner>\n</other_asset>"}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Printer"}},"status":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Operational"}},"manufacturer":{"type":"string","example":"Apple"},"ip":{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Printer"}},"status":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Operational"}},"manufacturer":{"type":"string","example":"Apple"},"ip":{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}},"example":"<other_asset>\n\t<name>Asset Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<asset_id>1</asset_id>\n\t<asset_type>\n\t\t<name>Object Name</name>\n\t</asset_type>\n\t<status>\n\t\t<name>Object Name</name>\n\t</status>\n\t<manufacturer>Apple</manufacturer>\n\t<ip>0.0.0.0</ip>\n\t<model>1</model>\n\t<serial_number>1</serial_number>\n\t<user>\n\t\t<email>john.doe@email.com</email>\n\t</user>\n\t<owner>\n\t\t<email>john.doe@email.com</email>\n\t</owner>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</other_asset>"}}},"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}]},"default_group_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_address":{"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}]},"default_group_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_address":{"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":"<other_asset>\n\t<id>1</id>\n\t<name>Apple 1</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<asset_type>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<parent_id>1</parent_id>\n\t\t<name>Asset Type</name>\n\t</asset_type>\n\t<asset_id>1</asset_id>\n\t<manufacturer>Apple</manufacturer>\n\t<model>1</model>\n\t<ip_address>0.0.0.0</ip_address>\n\t<serial_number>1</serial_number>\n\t<user>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user>\n\t<owner>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</owner>\n</other_asset>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the other assets","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as image url, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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_address":{"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"}}}}}}}}},"examples":{"layout=short":{"value":[{"other_asset":{"custom":null,"id":"1","name":"Apple 1","owner":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#1000","initials":"JD"}},"user":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#1000","initials":"JD"}},"description":"description","asset_id":"1","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"asset_type":{"id":161656,"account_id":5,"parent_id":0,"name":"Charger"},"category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"ip_address":"0.0.0.0","manufacturer":"Apple","model":"1","serial_number":"1","created_at":"2024-08-27T03:46:18.000-07:00","updated_at":"2024-08-27T03:46:18.000-07:00","address":null,"tasks":[],"maintenance_contract":null,"lease_contract":null,"incidents":[],"purchase":null,"purchase_orders":[],"tags":[],"hardware_dates":[{"id":163900753,"date":"2024-08-27","date_type":"Assigned","username":"John Doe","notes":"[Automatic] Technical contact changed to John Doe","user_type":null}],"latitude":null,"longitude":null,"custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","type_name":"Text"}]}}]},"layout=long":{"value":[{"other_asset":{"custom":null,"id":"1","name":"Apple 1","owner":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#1000","initials":"JD"}},"user":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#1000","initials":"JD"}},"description":"description","asset_id":"1","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"asset_type":{"id":161656,"account_id":5,"parent_id":0,"name":"Charger"},"category":{"id":10000,"name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":1,"default_group_assignee_id":"1","deleted":false},"status":{"id":1507926,"name":"Operational"},"ip_address":"0.0.0.0","manufacturer":"Apple","model":"1","serial_number":"1","created_at":"2024-08-27T03:46:18.000-07:00","updated_at":"2024-08-27T03:46:18.000-07:00","address":null,"tasks":[],"maintenance_contract":null,"lease_contract":null,"incidents":[],"purchase":null,"purchase_orders":[],"tags":[],"hardware_dates":[{"id":163900753,"date":"2024-08-27","date_type":"Assigned","username":"John Doe","notes":"[Automatic] Technical contact changed to John Doe","user_type":null}],"latitude":null,"longitude":null,"custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","type_name":"Text"}],"attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":true,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"},{"id":212598158,"content_type":"text/plain","size":251,"filename":"notpersonal.txt","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true","secure_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain","link_uuid_url":"/attachments/9d2e6444a7773cacab39","uuid":"9d2e6444a7773cacab39"}],"shared_attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","attachable_id":753657,"attachable_type":"Problem"}],"image_url":"https://mydomain.com/production.main.customer.data/images/959edaa5"}}]}}},"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}]},"default_group_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_address":{"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<other_asset>\n\t\t<id>1</id>\n\t\t<name>Apple 1</name>\n\t\t<description>description</description>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<status>Operational</status>\n\t\t<asset_type>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<parent_id>1</parent_id>\n\t\t\t<name>Asset Type</name>\n\t\t</asset_type>\n\t\t<asset_id>1</asset_id>\n\t\t<manufacturer>Apple</manufacturer>\n\t\t<model>1</model>\n\t\t<ip_address>0.0.0.0</ip_address>\n\t\t<serial_number>1</serial_number>\n\t\t<user>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</user>\n\t\t<owner>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</owner>\n\t</other_asset>\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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Printer"}},"status":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Operational"}},"manufacturer":{"type":"string","example":"Apple"},"ip":{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Printer"}},"status":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Operational"}},"manufacturer":{"type":"string","example":"Apple"},"ip":{"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","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]}}}}},"example":"<other_asset>\n\t<name>Asset Name</name>\n\t<description>description</description>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<asset_id>1</asset_id>\n\t<asset_type>\n\t\t<name>Object Name</name>\n\t</asset_type>\n\t<status>\n\t\t<name>Object Name</name>\n\t</status>\n\t<manufacturer>Apple</manufacturer>\n\t<ip>0.0.0.0</ip>\n\t<model>1</model>\n\t<serial_number>1</serial_number>\n\t<user>\n\t\t<email>john.doe@email.com</email>\n\t</user>\n\t<owner>\n\t\t<email>john.doe@email.com</email>\n\t</owner>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n</other_asset>"}}},"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}]},"default_group_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_address":{"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}]},"default_group_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_address":{"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":"<other_asset>\n\t<id>1</id>\n\t<name>Apple 1</name>\n\t<description>description</description>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<status>Operational</status>\n\t<asset_type>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<parent_id>1</parent_id>\n\t\t<name>Asset Type</name>\n\t</asset_type>\n\t<asset_id>1</asset_id>\n\t<manufacturer>Apple</manufacturer>\n\t<model>1</model>\n\t<ip_address>0.0.0.0</ip_address>\n\t<serial_number>1</serial_number>\n\t<user>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user>\n\t<owner>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</owner>\n</other_asset>"}}},"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":"<software>\n\t<id>1</id>\n\t<name>Google Chrome</name>\n\t<tag>software tag</tag>\n\t<manufacturer>Google LLC</manufacturer>\n\t<version>0.0.0</version>\n\t<category>Google softwares</category>\n\t<vendor>\n\t\t<id>1</id>\n\t\t<name>Google</name>\n\t\t<address>address description</address>\n\t\t<country>US</country>\n\t\t<city>Texas</city>\n\t\t<zip>1</zip>\n\t\t<tech_support>+000000000</tech_support>\n\t\t<business_phone>+000000000</business_phone>\n\t\t<url>www.google.com</url>\n\t\t<created_at>2020-01-01T00:00:00.000+01:00</created_at>\n\t\t<updated_at>2020-10-01T00:00:00.000+01:00</updated_at>\n\t</vendor>\n\t<installs>1</installs>\n\t<created_at>2020-01-01T00:00:00.000+01:00</created_at>\n\t<updated_at>2020-10-01T00:00:00.000+01:00</updated_at>\n</software>"}}},"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<software>\n\t\t<id>1</id>\n\t\t<name>Google Chrome</name>\n\t\t<tag>software tag</tag>\n\t\t<manufacturer>Google LLC</manufacturer>\n\t\t<version>0.0.0</version>\n\t\t<category>Google softwares</category>\n\t\t<vendor>\n\t\t\t<id>1</id>\n\t\t\t<name>Google</name>\n\t\t\t<address>address description</address>\n\t\t\t<country>US</country>\n\t\t\t<city>Texas</city>\n\t\t\t<zip>1</zip>\n\t\t\t<tech_support>+000000000</tech_support>\n\t\t\t<business_phone>+000000000</business_phone>\n\t\t\t<url>www.google.com</url>\n\t\t\t<created_at>2020-01-01T00:00:00.000+01:00</created_at>\n\t\t\t<updated_at>2020-10-01T00:00:00.000+01:00</updated_at>\n\t\t</vendor>\n\t\t<installs>1</installs>\n\t\t<created_at>2020-01-01T00:00:00.000+01:00</created_at>\n\t\t<updated_at>2020-10-01T00:00:00.000+01:00</updated_at>\n\t</software>\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}]},"default_group_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}]},"default_group_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":"<printer>\n\t<id>1</id>\n\t<name>HP Color Printer</name>\n\t<driver>Driver description</driver>\n\t<port>Port description</port>\n\t<shared>true</shared>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<technical_contact>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</technical_contact>\n</printer>"}}},"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","anyOf":[{"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","anyOf":[{"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":"<printer>\n\t<site_id>1</site_id>\n\t<department_id>1</department_id>\n\t<technical_contact>\n\t\t<email>john.doe@email.com</email>\n\t</technical_contact>\n\t<address>address description</address>\n</printer>"}}},"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}]},"default_group_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}]},"default_group_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":"<printer>\n\t<id>1</id>\n\t<name>HP Color Printer</name>\n\t<driver>Driver description</driver>\n\t<port>Port description</port>\n\t<shared>true</shared>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<technical_contact>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</technical_contact>\n</printer>"}}},"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}]},"default_group_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}]},"default_group_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<printer>\n\t\t<id>1</id>\n\t\t<name>HP Color Printer</name>\n\t\t<driver>Driver description</driver>\n\t\t<port>Port description</port>\n\t\t<shared>true</shared>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<technical_contact>\n\t\t\t<group_id>1</group_id>\n\t\t\t<is_user>true</is_user>\n\t\t\t<id>1</id>\n\t\t\t<name>John Doe</name>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</technical_contact>\n\t</printer>\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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the contracts","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as purchases, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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"}}}}}}}},"examples":{"layout=short":{"value":{"contract":{"id":"1","name":"Contract Name","type":"Software License","manufacturer_name":"Apple","start_date":"2020-01-01T00:00:00-00:00","end_date":"2030-01-01T00:00:00-00:00","created_at":"2024-08-25T07:32:16.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","note":"Contract Note","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"items":[{"name":"appendix","version":"1.23","quantity":1,"language":null,"date":null,"rate":null,"notes":null,"created_at":"2024-08-25T07:29:17.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","tag":"dag","manufacturer":null,"contract":null,"inventory":null,"variance":null}],"status":"Active","custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","type_name":"Text"}]}}},"layout=long":{"value":{"contract":{"id":"1","name":"Contract Name","type":"Software License","manufacturer_name":"Apple","start_date":"2020-01-01T00:00:00-00:00","end_date":"2030-01-01T00:00:00-00:00","created_at":"2024-08-25T07:32:16.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","note":"Contract Note","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"items":[{"name":"appendix","version":"1.23","quantity":1,"language":null,"date":null,"rate":null,"notes":null,"created_at":"2024-08-25T07:29:17.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","tag":"dag","manufacturer":null,"contract":null,"inventory":null,"variance":null}],"status":"Active","custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","type_name":"Text"}],"purchases":[{"id":266602,"date":"2024-08-21T00:00:00.000-07:00","number":"11","notes":"a","total_cost":"83727400.0","currency":"USD","recurrence":"One_Time","created_at":"2024-08-25T07:29:49.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","vendor":{"id":153707,"href":"https://api.samanage.com/vendors/153707-amazon","name":"Amazon","url":"","contact_name":"","contact_email":"","contact_phone":"","note":"","address":"","city":"","state":"","zip":"","telephone":"","vendor_type":{"id":50,"name":"Computer Hardware Vendor"}}}],"total_financial_value":"USD 83,727,400.00","attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"},{"id":212598158,"content_type":"text/plain","size":251,"filename":"notpersonal.txt","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true","secure_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain","link_uuid_url":"/attachments/9d2e6444a7773cacab39","uuid":"9d2e6444a7773cacab39"}],"owner":{"group_id":9302435,"is_user":true,"id":8614513,"name":"Elad Kaufman","disabled":false,"title":"Sir","email":"elad.kaufman@solarwinds.com","created_at":"2022-08-16T04:54:17.000-07:00","updated_at":"2024-08-21T00:24:46.000-07:00","last_login":"2024-08-21T00:24:46.000-07:00","phone":"","mobile_phone":"","role":{"id":90,"name":"Administrator","description":"This is the all powerful administrator user!","portal":false,"show_my_tasks":false},"group_ids":[9302435,10067404,11826868,11827076],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"SolarWinds","custom_fields_values":[],"site":null,"department":null,"avatar":{"type":"initials","initials":"EK","color":"#0089c9"},"reports_to":null},"technical_owner":{"group_id":10128208,"is_user":true,"id":9355701,"name":"elad2","disabled":false,"title":"","email":"elad.kaufman+2@solarwinds.com","created_at":"2023-04-03T00:51:46.000-07:00","updated_at":"2023-05-21T05:34:27.000-07:00","last_login":"2023-04-03T00:53:25.000-07:00","phone":"","mobile_phone":"","role":{"id":90,"name":"Administrator","description":"This is the all powerful administrator user!","portal":false,"show_my_tasks":false},"group_ids":[10128208],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"SolarWinds","custom_fields_values":[],"site":null,"department":null,"avatar":{"type":"initials","initials":"EL","color":"#fd4165"},"reports_to":null},"purchasing_owner":{"group_id":10128208,"is_user":true,"id":9355701,"name":"elad2","disabled":false,"title":"","email":"elad.kaufman+2@solarwinds.com","created_at":"2023-04-03T00:51:46.000-07:00","updated_at":"2023-05-21T05:34:27.000-07:00","last_login":"2023-04-03T00:53:25.000-07:00","phone":"","mobile_phone":"","role":{"id":90,"name":"Administrator","description":"This is the all powerful administrator user!","portal":false,"show_my_tasks":false},"group_ids":[10128208],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"SolarWinds","custom_fields_values":[],"site":null,"department":null,"avatar":{"type":"initials","initials":"EL","color":"#fd4165"},"reports_to":null},"license_type":"Enterprise","tag_list":["tag name"],"parent_contracts":null,"child_contracts":null,"associated_contracts":[{"id":782243,"href":"https://api.samanage.com/contracts/782243"}]}}}}},"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}]},"default_group_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":"<contract>\n\t<id>1</id>\n\t<name>Contract Name</name>\n\t<type>Software License</type>\n\t<manufacturer_name>Apple</manufacturer_name>\n\t<note>Contract Note</note>\n\t<status>Active</status>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<start_date>2020-01-01T00:00:00-00:00</start_date>\n\t<end_date>2030-01-01T00:00:00-00:00</end_date>\n</contract>"}}},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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":"<contract>\n\t<type>Software License</type>\n\t<manufacturer_name>Apple</manufacturer_name>\n\t<name>Contract Name</name>\n\t<note>Contract Note</note>\n\t<status>Active</status>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<start_date>2020-01-01T00:00:00-00:00</start_date>\n\t<end_date>2030-01-01T00:00:00-00:00</end_date>\n\t<tag_list>tag1, tag2</tag_list>\n</contract>"}}},"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}]},"default_group_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}]},"default_group_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":"<contract>\n\t<id>1</id>\n\t<name>Contract Name</name>\n\t<type>Software License</type>\n\t<manufacturer_name>Apple</manufacturer_name>\n\t<note>Contract Note</note>\n\t<status>Active</status>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<start_date>2020-01-01T00:00:00-00:00</start_date>\n\t<end_date>2030-01-01T00:00:00-00:00</end_date>\n</contract>"}}},"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"},{"name":"layout","in":"query","description":"For detailed information and the complete set of data returned with each layout, please refer to the response samples","required":false,"schema":{"type":"string","default":"short"},"examples":{"example1":{"summary":"Retrieves general data about the contracts","value":{"":"layout=short"}},"example2":{"summary":"Provides more detailed information, including properties such as purchases, attachments and more","value":{"":"layout=long"}}}}],"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}]},"default_group_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"}}}}}}}}},"examples":{"layout=short":{"value":[{"contract":{"id":"1","name":"Contract Name","type":"Software License","manufacturer_name":"Apple","start_date":"2020-01-01T00:00:00-00:00","end_date":"2030-01-01T00:00:00-00:00","created_at":"2024-08-25T07:32:16.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","note":"Contract Note","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"items":[{"name":"appendix","version":"1.23","quantity":1,"language":null,"date":null,"rate":null,"notes":null,"created_at":"2024-08-25T07:29:17.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","tag":"dag","manufacturer":null,"contract":null,"inventory":null,"variance":null}],"status":"Active","custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","type_name":"Text"}]}}]},"layout=long":{"value":[{"contract":{"id":"1","name":"Contract Name","type":"Software License","manufacturer_name":"Apple","start_date":"2020-01-01T00:00:00-00:00","end_date":"2030-01-01T00:00:00-00:00","created_at":"2024-08-25T07:32:16.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","note":"Contract Note","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":"","default_assignee_id":"1","default_group_assignee_id":"1"},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1","default_group_assignee_id":"1"},"items":[{"name":"appendix","version":"1.23","quantity":1,"language":null,"date":null,"rate":null,"notes":null,"created_at":"2024-08-25T07:29:17.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","tag":"dag","manufacturer":null,"contract":null,"inventory":null,"variance":null}],"status":"Active","custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","type_name":"Text"}],"purchases":[{"id":266602,"date":"2024-08-21T00:00:00.000-07:00","number":"11","notes":"a","total_cost":"83727400.0","currency":"USD","recurrence":"One_Time","created_at":"2024-08-25T07:29:49.000-07:00","updated_at":"2024-08-25T07:32:17.000-07:00","vendor":{"id":153707,"href":"https://api.samanage.com/vendors/153707-amazon","name":"Amazon","url":"","contact_name":"","contact_email":"","contact_phone":"","note":"","address":"","city":"","state":"","zip":"","telephone":"","vendor_type":{"id":50,"name":"Computer Hardware Vendor"}}}],"total_financial_value":"USD 83,727,400.00","attachments":[{"id":212598157,"content_type":"application/json","size":583,"filename":"myjson.json","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json?thumb=true","secure_url":"/attachments/c4d6df03448d80c4d9c1/myjson.json","link_uuid_url":"/attachments/c4d6df03448d80c4d9c1","uuid":"c4d6df03448d80c4d9c1"},{"id":212598158,"content_type":"text/plain","size":251,"filename":"notpersonal.txt","url":"https://mydomain.com/attachments/c4d6df03448d80c4d9c1/myjson","shared_attachment":false,"attachable_id":753657,"attachable_type":"Problem","attachment_type":"attachment","thumb_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain?thumb=true","secure_url":"/attachments/9d2e6444a7773cacab39/notpersonal-txt.plain","link_uuid_url":"/attachments/9d2e6444a7773cacab39","uuid":"9d2e6444a7773cacab39"}],"owner":{"group_id":9302435,"is_user":true,"id":8614513,"name":"Elad Kaufman","disabled":false,"title":"Sir","email":"elad.kaufman@solarwinds.com","created_at":"2022-08-16T04:54:17.000-07:00","updated_at":"2024-08-21T00:24:46.000-07:00","last_login":"2024-08-21T00:24:46.000-07:00","phone":"","mobile_phone":"","role":{"id":90,"name":"Administrator","description":"This is the all powerful administrator user!","portal":false,"show_my_tasks":false},"group_ids":[9302435,10067404,11826868,11827076],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"SolarWinds","custom_fields_values":[],"site":null,"department":null,"avatar":{"type":"initials","initials":"EK","color":"#0089c9"},"reports_to":null},"technical_owner":{"group_id":10128208,"is_user":true,"id":9355701,"name":"elad2","disabled":false,"title":"","email":"elad.kaufman+2@solarwinds.com","created_at":"2023-04-03T00:51:46.000-07:00","updated_at":"2023-05-21T05:34:27.000-07:00","last_login":"2023-04-03T00:53:25.000-07:00","phone":"","mobile_phone":"","role":{"id":90,"name":"Administrator","description":"This is the all powerful administrator user!","portal":false,"show_my_tasks":false},"group_ids":[10128208],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"SolarWinds","custom_fields_values":[],"site":null,"department":null,"avatar":{"type":"initials","initials":"EL","color":"#fd4165"},"reports_to":null},"purchasing_owner":{"group_id":10128208,"is_user":true,"id":9355701,"name":"elad2","disabled":false,"title":"","email":"elad.kaufman+2@solarwinds.com","created_at":"2023-04-03T00:51:46.000-07:00","updated_at":"2023-05-21T05:34:27.000-07:00","last_login":"2023-04-03T00:53:25.000-07:00","phone":"","mobile_phone":"","role":{"id":90,"name":"Administrator","description":"This is the all powerful administrator user!","portal":false,"show_my_tasks":false},"group_ids":[10128208],"available_for_assignment":false,"can_be_available_for_assignment":false,"provider":"SolarWinds","custom_fields_values":[],"site":null,"department":null,"avatar":{"type":"initials","initials":"EL","color":"#fd4165"},"reports_to":null},"license_type":"Enterprise","tag_list":["tag name"],"parent_contracts":null,"child_contracts":null,"associated_contracts":[{"id":782243,"href":"https://api.samanage.com/contracts/782243"}]}}]}}},"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}]},"default_group_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<contract>\n\t\t<id>1</id>\n\t\t<name>Contract Name</name>\n\t\t<type>Software License</type>\n\t\t<manufacturer_name>Apple</manufacturer_name>\n\t\t<note>Contract Note</note>\n\t\t<status>Active</status>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<start_date>2020-01-01T00:00:00-00:00</start_date>\n\t\t<end_date>2030-01-01T00:00:00-00:00</end_date>\n\t</contract>\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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"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":"<contract>\n\t<type>Software License</type>\n\t<manufacturer_name>Apple</manufacturer_name>\n\t<name>Contract Name</name>\n\t<note>Contract Note</note>\n\t<status>Active</status>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<start_date>2020-01-01T00:00:00-00:00</start_date>\n\t<end_date>2030-01-01T00:00:00-00:00</end_date>\n\t<tag_list>tag1, tag2</tag_list>\n</contract>"}}},"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}]},"default_group_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}]},"default_group_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":"<contract>\n\t<id>1</id>\n\t<name>Contract Name</name>\n\t<type>Software License</type>\n\t<manufacturer_name>Apple</manufacturer_name>\n\t<note>Contract Note</note>\n\t<status>Active</status>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Austin TX, USA</name>\n\t\t<description>AUS</description>\n\t\t<location>AUS</location>\n\t\t<timezone>UTC-6h</timezone>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Support</name>\n\t\t<description>Support Department</description>\n\t\t<default_assignee_id>1</default_assignee_id>\n\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t</department>\n\t<start_date>2020-01-01T00:00:00-00:00</start_date>\n\t<end_date>2030-01-01T00:00:00-00:00</end_date>\n</contract>"}}},"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"},"shipping_address":{"type":"string","example":"Shipping 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":{"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"},"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}}},"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"},"shipping_address":{"type":"string","example":"Shipping 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":{"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"},"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"example":"<purchase_order>\n\t<id>1</id>\n\t<name>Purchase order Name</name>\n\t<order_date>2025-01-01T00:00:00.000+01:00</order_date>\n\t<due_date>2030-01-01T00:00:00.000+01:00</due_date>\n\t<buyer>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</buyer>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</department>\n\t<state>Approved</state>\n\t<requester>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</requester>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</vendor>\n\t<billing_address>Billing address</billing_address>\n\t<shipping_address>Shipping address</shipping_address>\n\t<payment_terms>Purchase terms</payment_terms>\n\t<terms_conditions>Terms conditions</terms_conditions>\n</purchase_order>"}}},"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"},{"name":"edit_mode","in":"query","schema":{"type":"boolean"},"description":"For creating multiple level of approvers you must set this parameter to true: {DOMAIN_NAME}/purchase_orders?edit_mode=true","example":"true"}],"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}]},"buyer":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"order_date":{"type":"string","example":"Jan 01, 2025"},"due_date":{"type":"string","example":"Jan 01, 2030"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","anyOf":[{"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"},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"billing_address":{"type":"string","example":"Billing address"},"shipping_address":{"type":"string","example":"Shipping 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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"approval_levels_attributes":{"type":"object","properties":{"1":{"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"}}},"2":{"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"}}}}},"purchase_order_items_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"Required field for update operations"},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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}]},"buyer":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"order_date":{"type":"string","example":"Jan 01, 2025"},"due_date":{"type":"string","example":"Jan 01, 2030"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","anyOf":[{"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"},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"billing_address":{"type":"string","example":"Billing address"},"shipping_address":{"type":"string","example":"Shipping 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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"approval_levels_attributes":{"type":"object","properties":{"approval_level":{"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"}}}}},"purchase_order_items_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"Required field for update operations"},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"example":"<purchase_order>\n\t<name>Purchase order Name</name>\n\t<buyer_id>1</buyer_id>\n\t<buyer>\n\t\t<email>john.doe@email.com</email>\n\t</buyer>\n\t<order_date>Jan 01, 2025</order_date>\n\t<due_date>Jan 01, 2030</due_date>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<state>Approved</state>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<tax>1</tax>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<name>Object Name</name>\n\t</vendor>\n\t<billing_address>Billing address</billing_address>\n\t<shipping_address>Shipping address</shipping_address>\n\t<payment_terms>Purchase terms</payment_terms>\n\t<terms_conditions>Terms conditions</terms_conditions>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<approval_levels_attributes>\n\t\t<1>\n\t\t\t<id>1</id>\n\t\t\t<approver_ids>1, 2</approver_ids>\n\t\t\t<approval_condition>1</approval_condition>\n\t\t</1>\n\t\t<2>\n\t\t\t<id>1</id>\n\t\t\t<approver_ids>1, 2</approver_ids>\n\t\t\t<approval_condition>1</approval_condition>\n\t\t</2>\n\t</approval_levels_attributes>\n</purchase_order>"}}},"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"},"shipping_address":{"type":"string","example":"Shipping 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":{"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"},"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}}},"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"},"shipping_address":{"type":"string","example":"Shipping 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":{"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"},"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"example":"<purchase_order>\n\t<id>1</id>\n\t<name>Purchase order Name</name>\n\t<order_date>2025-01-01T00:00:00.000+01:00</order_date>\n\t<due_date>2030-01-01T00:00:00.000+01:00</due_date>\n\t<buyer>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</buyer>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</department>\n\t<state>Approved</state>\n\t<requester>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</requester>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</vendor>\n\t<billing_address>Billing address</billing_address>\n\t<shipping_address>Shipping address</shipping_address>\n\t<payment_terms>Purchase terms</payment_terms>\n\t<terms_conditions>Terms conditions</terms_conditions>\n</purchase_order>"}}},"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"},"shipping_address":{"type":"string","example":"Shipping 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":{"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"},"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}}}},"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"},"shipping_address":{"type":"string","example":"Shipping 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":{"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"},"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}}},"example":"<>\n\t<purchase_order>\n\t\t<id>1</id>\n\t\t<name>Purchase order Name</name>\n\t\t<order_date>2025-01-01T00:00:00.000+01:00</order_date>\n\t\t<due_date>2030-01-01T00:00:00.000+01:00</due_date>\n\t\t<buyer>\n\t\t\t<id>1</id>\n\t\t\t<name>Object Name</name>\n\t\t\t<href>/objects/1</href>\n\t\t</buyer>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Object Name</name>\n\t\t\t<href>/objects/1</href>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Object Name</name>\n\t\t\t<href>/objects/1</href>\n\t\t</department>\n\t\t<state>Approved</state>\n\t\t<requester>\n\t\t\t<id>1</id>\n\t\t\t<name>Object Name</name>\n\t\t\t<href>/objects/1</href>\n\t\t</requester>\n\t\t<recurrence>Monthly</recurrence>\n\t\t<total_cost>1</total_cost>\n\t\t<currency>USD</currency>\n\t\t<notes>Purchase notes</notes>\n\t\t<vendor>\n\t\t\t<id>1</id>\n\t\t\t<name>Object Name</name>\n\t\t\t<href>/objects/1</href>\n\t\t</vendor>\n\t\t<billing_address>Billing address</billing_address>\n\t\t<shipping_address>Shipping address</shipping_address>\n\t\t<payment_terms>Purchase terms</payment_terms>\n\t\t<terms_conditions>Terms conditions</terms_conditions>\n\t</purchase_order>\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"},{"name":"edit_mode","in":"query","schema":{"type":"boolean"},"description":"For creating multiple level of approvers you must set this parameter to true: {DOMAIN_NAME}/purchase_orders?edit_mode=true","example":"true"}],"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}]},"buyer":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"order_date":{"type":"string","example":"Jan 01, 2025"},"due_date":{"type":"string","example":"Jan 01, 2030"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","anyOf":[{"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"},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"billing_address":{"type":"string","example":"Billing address"},"shipping_address":{"type":"string","example":"Shipping 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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"approval_levels_attributes":{"type":"object","properties":{"1":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}},"2":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}}}},"purchase_order_items_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"Required field for update operations"},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","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}]},"buyer":{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"order_date":{"type":"string","example":"Jan 01, 2025"},"due_date":{"type":"string","example":"Jan 01, 2030"},"site":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","anyOf":[{"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"},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"billing_address":{"type":"string","example":"Billing address"},"shipping_address":{"type":"string","example":"Shipping 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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]},"user_value":{"anyOf":[{"type":"object","anyOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},{"nullable":true}]}}}]}}},"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}},{"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":"string","format":"binary","description":"attachment custom field"},{"nullable":true}]}}}}]},"approval_levels_attributes":{"type":"object","properties":{"approval_level":{"type":"object","properties":{"approver_ids":{"type":"string","example":"1, 2, 3"},"approval_condition":{"type":"string","example":"1"}}}}},"purchase_order_items_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"Required field for update operations"},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"example":"<purchase_order>\n\t<name>Purchase order Name</name>\n\t<buyer_id>1</buyer_id>\n\t<buyer>\n\t\t<email>john.doe@email.com</email>\n\t</buyer>\n\t<order_date>Jan 01, 2025</order_date>\n\t<due_date>Jan 01, 2030</due_date>\n\t<site>\n\t\t<name>Object Name</name>\n\t</site>\n\t<department>\n\t\t<name>Object Name</name>\n\t</department>\n\t<state>Approved</state>\n\t<requester>\n\t\t<email>john.doe@email.com</email>\n\t</requester>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<tax>1</tax>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<name>Object Name</name>\n\t</vendor>\n\t<billing_address>Billing address</billing_address>\n\t<shipping_address>Shipping address</shipping_address>\n\t<payment_terms>Purchase terms</payment_terms>\n\t<terms_conditions>Terms conditions</terms_conditions>\n\t<custom_fields_values>\n\t\t<custom_fields_value>1</custom_fields_value>\n\t</custom_fields_values>\n\t<custom_fields_values_attributes>1</custom_fields_values_attributes>\n\t<approval_levels_attributes>\n\t\t<1>\n\t\t\t<approver_ids>1, 2, 3</approver_ids>\n\t\t\t<approval_condition>1</approval_condition>\n\t\t</1>\n\t\t<2>\n\t\t\t<approver_ids>1, 2, 3</approver_ids>\n\t\t\t<approval_condition>1</approval_condition>\n\t\t</2>\n\t</approval_levels_attributes>\n</purchase_order>"}}},"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"},"shipping_address":{"type":"string","example":"Shipping 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":{"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"},"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}}},"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"},"shipping_address":{"type":"string","example":"Shipping 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":{"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"},"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"description":{"type":"string","example":"Item Description"},"serial_number":{"type":"string","example":"XXXXX"},"part_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"price":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"quantity":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"discount":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tax":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"example":"<purchase_order>\n\t<id>1</id>\n\t<name>Purchase order Name</name>\n\t<order_date>2025-01-01T00:00:00.000+01:00</order_date>\n\t<due_date>2030-01-01T00:00:00.000+01:00</due_date>\n\t<buyer>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</buyer>\n\t<site>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</site>\n\t<department>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</department>\n\t<state>Approved</state>\n\t<requester>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</requester>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<id>1</id>\n\t\t<name>Object Name</name>\n\t\t<href>/objects/1</href>\n\t</vendor>\n\t<billing_address>Billing address</billing_address>\n\t<shipping_address>Shipping address</shipping_address>\n\t<payment_terms>Purchase terms</payment_terms>\n\t<terms_conditions>Terms conditions</terms_conditions>\n</purchase_order>"}}},"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":"<vendor>\n\t<id>1</id>\n\t<name>SolarWinds</name>\n\t<vendor_type>\n\t\t<id>1</id>\n\t\t<name>General Business Vendor</name>\n\t</vendor_type>\n\t<url>www.solarwinds.com</url>\n\t<contact_name>Support</contact_name>\n\t<contact_email>support@solarwinds.com</contact_email>\n\t<contact_phone>+000000000</contact_phone>\n\t<note>Notes</note>\n\t<address>Address description</address>\n\t<city>Cary</city>\n\t<state>NC</state>\n\t<zip>USA 11111</zip>\n\t<telephone>+000000000</telephone>\n</vendor>"}}},"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","anyOf":[{"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","anyOf":[{"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":"<vendor>\n\t<name>SolarWinds</name>\n\t<vendor_type>\n\t\t<name>Object Name</name>\n\t</vendor_type>\n\t<url>www.solarwinds.com</url>\n\t<contact_name>Support</contact_name>\n\t<contact_email>support@solarwinds.com</contact_email>\n\t<contact_phone>+000000000</contact_phone>\n\t<note>Notes</note>\n\t<address>Address description</address>\n\t<city>Cary</city>\n\t<state>NC</state>\n\t<zip>USA 11111</zip>\n\t<telephone>+000000000</telephone>\n</vendor>"}}},"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":"<vendor>\n\t<id>1</id>\n\t<name>SolarWinds</name>\n\t<vendor_type>\n\t\t<id>1</id>\n\t\t<name>General Business Vendor</name>\n\t</vendor_type>\n\t<url>www.solarwinds.com</url>\n\t<contact_name>Support</contact_name>\n\t<contact_email>support@solarwinds.com</contact_email>\n\t<contact_phone>+000000000</contact_phone>\n\t<note>Notes</note>\n\t<address>Address description</address>\n\t<city>Cary</city>\n\t<state>NC</state>\n\t<zip>USA 11111</zip>\n\t<telephone>+000000000</telephone>\n</vendor>"}}},"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<vendor>\n\t\t<id>1</id>\n\t\t<name>SolarWinds</name>\n\t\t<vendor_type>\n\t\t\t<id>1</id>\n\t\t\t<name>General Business Vendor</name>\n\t\t</vendor_type>\n\t\t<url>www.solarwinds.com</url>\n\t\t<contact_name>Support</contact_name>\n\t\t<contact_email>support@solarwinds.com</contact_email>\n\t\t<contact_phone>+000000000</contact_phone>\n\t\t<note>Notes</note>\n\t\t<address>Address description</address>\n\t\t<city>Cary</city>\n\t\t<state>NC</state>\n\t\t<zip>USA 11111</zip>\n\t\t<telephone>+000000000</telephone>\n\t</vendor>\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","anyOf":[{"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","anyOf":[{"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":"<vendor>\n\t<name>SolarWinds</name>\n\t<vendor_type>\n\t\t<name>Object Name</name>\n\t</vendor_type>\n\t<url>www.solarwinds.com</url>\n\t<contact_name>Support</contact_name>\n\t<contact_email>support@solarwinds.com</contact_email>\n\t<contact_phone>+000000000</contact_phone>\n\t<note>Notes</note>\n\t<address>Address description</address>\n\t<city>Cary</city>\n\t<state>NC</state>\n\t<zip>USA 11111</zip>\n\t<telephone>+000000000</telephone>\n</vendor>"}}},"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":"<vendor>\n\t<id>1</id>\n\t<name>SolarWinds</name>\n\t<vendor_type>\n\t\t<id>1</id>\n\t\t<name>General Business Vendor</name>\n\t</vendor_type>\n\t<url>www.solarwinds.com</url>\n\t<contact_name>Support</contact_name>\n\t<contact_email>support@solarwinds.com</contact_email>\n\t<contact_phone>+000000000</contact_phone>\n\t<note>Notes</note>\n\t<address>Address description</address>\n\t<city>Cary</city>\n\t<state>NC</state>\n\t<zip>USA 11111</zip>\n\t<telephone>+000000000</telephone>\n</vendor>"}}},"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":"<item>\n\t<name>Item Name</name>\n\t<version>1</version>\n\t<qty>1</qty>\n\t<tag>Item tag</tag>\n</item>"}}},"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":"<item>\n\t<id>1</id>\n\t<name>Item Name</name>\n\t<version>1</version>\n\t<qty>1</qty>\n\t<tag>Item tag</tag>\n</item>"}}},"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":"<item>\n\t<name>Item Name</name>\n\t<version>1</version>\n\t<qty>1</qty>\n\t<tag>Item tag</tag>\n</item>"}}},"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":"<item>\n\t<id>1</id>\n\t<name>Item Name</name>\n\t<version>1</version>\n\t<qty>1</qty>\n\t<tag>Item tag</tag>\n</item>"}}},"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","anyOf":[{"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","anyOf":[{"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":"<task>\n\t<name>Task Name</name>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<due_at>Jan 01, 2030</due_at>\n\t<is_complete>true</is_complete>\n</task>"}}},"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":"<task>\n\t<id>1</id>\n\t<name>Task Name</name>\n\t<due_at>2030-01-01T00:00:00.000+01:00</due_at>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<parent>\n\t\t<id>1</id>\n\t\t<class>Incident</class>\n\t</parent>\n</task>"}}},"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","anyOf":[{"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","anyOf":[{"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":"<task>\n\t<name>Task Name</name>\n\t<assignee>\n\t\t<email>john.doe@email.com</email>\n\t</assignee>\n\t<due_at>Jan 01, 2030</due_at>\n\t<is_complete>true</is_complete>\n</task>"}}},"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":"<task>\n\t<id>1</id>\n\t<name>Task Name</name>\n\t<due_at>2030-01-01T00:00:00.000+01:00</due_at>\n\t<requester>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</requester>\n\t<assignee>\n\t\t<group_id>1</group_id>\n\t\t<is_user>true</is_user>\n\t\t<id>1</id>\n\t\t<name>John Doe</name>\n\t\t<email>john.doe@email.com</email>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</assignee>\n\t<parent>\n\t\t<id>1</id>\n\t\t<class>Incident</class>\n\t</parent>\n</task>"}}},"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"},{"name":"add_callbacks","in":"query","schema":{"type":"boolean"},"description":"API calls do not trigger notifications by default. To enable callbacks, include the query parameter add_callbacks=true.","example":"true"}],"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}]},"user_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"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}]},"user_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<comment>\n\t<body>Comment body</body>\n\t<is_private>true</is_private>\n\t<user_id>1</user_id>\n</comment>"}}},"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":"<comment>\n\t<id>1</id>\n\t<body>Comment body</body>\n\t<is_private>true</is_private>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t<user>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user>\n\t<commenter_id>1</commenter_id>\n\t<commenter_type>Incident</commenter_type>\n</comment>"}}},"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}]},"user_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"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}]},"user_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":"<comment>\n\t<body>Comment body</body>\n\t<is_private>true</is_private>\n\t<user_id>1</user_id>\n</comment>"}}},"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":"<comment>\n\t<id>1</id>\n\t<body>Comment body</body>\n\t<is_private>true</is_private>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t<user>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</user>\n\t<commenter_id>1</commenter_id>\n\t<commenter_type>Incident</commenter_type>\n</comment>"}}},"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<warranty>\n\t\t<id>1</id>\n\t\t<service>Warranty service description</service>\n\t\t<provider>SolarWinds</provider>\n\t\t<start_date>2020-01-01T00:00:00.000+01:00</start_date>\n\t\t<end_date>2030-01-01T00:00:00.000+01:00</end_date>\n\t\t<status>Active</status>\n\t\t<manual>true</manual>\n\t</warranty>\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":"<warranty>\n\t<service>Warranty service description</service>\n\t<provider>SolarWinds</provider>\n\t<start_date>Jan 01, 2020</start_date>\n\t<end_date>Jan 01, 2030</end_date>\n\t<status>Active</status>\n</warranty>"}}},"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":"<warranty>\n\t<id>1</id>\n\t<service>Warranty service description</service>\n\t<provider>SolarWinds</provider>\n\t<start_date>2020-01-01T00:00:00.000+01:00</start_date>\n\t<end_date>2030-01-01T00:00:00.000+01:00</end_date>\n\t<status>Active</status>\n\t<manual>true</manual>\n</warranty>"}}},"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":"<warranty>\n\t<service>Warranty service description</service>\n\t<provider>SolarWinds</provider>\n\t<start_date>Jan 01, 2020</start_date>\n\t<end_date>Jan 01, 2030</end_date>\n\t<status>Active</status>\n</warranty>"}}},"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":"<warranty>\n\t<id>1</id>\n\t<service>Warranty service description</service>\n\t<provider>SolarWinds</provider>\n\t<start_date>2020-01-01T00:00:00.000+01:00</start_date>\n\t<end_date>2030-01-01T00:00:00.000+01:00</end_date>\n\t<status>Active</status>\n\t<manual>true</manual>\n</warranty>"}}},"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<time_track>\n\t\t<id>1</id>\n\t\t<name>Time Track Name</name>\n\t\t<minutes>120</minutes>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t\t<creator>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</creator>\n\t\t<parent>\n\t\t\t<id>1</id>\n\t\t\t<class>Incident</class>\n\t\t</parent>\n\t</time_track>\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":"<time_track>\n\t<name>Time Track Name</name>\n\t<minutes_parsed>2h</minutes_parsed>\n</time_track>"}}},"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":"<time_track>\n\t<id>1</id>\n\t<name>Time Track Name</name>\n\t<minutes>120</minutes>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t<creator>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</creator>\n\t<parent>\n\t\t<id>1</id>\n\t\t<class>Incident</class>\n\t</parent>\n</time_track>"}}},"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":"<time_track>\n\t<name>Time Track Name</name>\n\t<minutes_parsed>2h</minutes_parsed>\n</time_track>"}}},"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":"<time_track>\n\t<id>1</id>\n\t<name>Time Track Name</name>\n\t<minutes>120</minutes>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<updated_at>2025-01-01T00:00:00.000+01:00</updated_at>\n\t<creator>\n\t\t<id>1</id>\n\t\t<account_id>1</account_id>\n\t\t<user_id>1</user_id>\n\t\t<email>john.doe@email.com</email>\n\t\t<name>John Doe</name>\n\t\t<disabled>true</disabled>\n\t\t<avatar>\n\t\t\t<type>initials</type>\n\t\t\t<color>#1000</color>\n\t\t\t<initials>JD</initials>\n\t\t</avatar>\n\t</creator>\n\t<parent>\n\t\t<id>1</id>\n\t\t<class>Incident</class>\n\t</parent>\n</time_track>"}}},"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","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]}}}}},"example":"<purchase>\n\t<number>1</number>\n\t<date>Jan 01, 2025</date>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<name>Object Name</name>\n\t</vendor>\n</purchase>"}}},"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":"<purchase>\n\t<id>1</id>\n\t<number>1</number>\n\t<date>Jan 01, 2025</date>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<id>1</id>\n\t\t<name>Google</name>\n\t\t<address>address description</address>\n\t\t<country>US</country>\n\t\t<city>Texas</city>\n\t\t<zip>1</zip>\n\t\t<tech_support>+000000000</tech_support>\n\t\t<business_phone>+000000000</business_phone>\n\t\t<url>www.google.com</url>\n\t\t<created_at>2020-01-01T00:00:00.000+01:00</created_at>\n\t\t<updated_at>2020-10-01T00:00:00.000+01:00</updated_at>\n\t</vendor>\n</purchase>"}}},"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","anyOf":[{"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","anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]}}}}},"example":"<purchase>\n\t<number>1</number>\n\t<date>Jan 01, 2025</date>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<name>Object Name</name>\n\t</vendor>\n</purchase>"}}},"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":"<purchase>\n\t<id>1</id>\n\t<number>1</number>\n\t<date>Jan 01, 2025</date>\n\t<recurrence>Monthly</recurrence>\n\t<total_cost>1</total_cost>\n\t<currency>USD</currency>\n\t<notes>Purchase notes</notes>\n\t<vendor>\n\t\t<id>1</id>\n\t\t<name>Google</name>\n\t\t<address>address description</address>\n\t\t<country>US</country>\n\t\t<city>Texas</city>\n\t\t<zip>1</zip>\n\t\t<tech_support>+000000000</tech_support>\n\t\t<business_phone>+000000000</business_phone>\n\t\t<url>www.google.com</url>\n\t\t<created_at>2020-01-01T00:00:00.000+01:00</created_at>\n\t\t<updated_at>2020-10-01T00:00:00.000+01:00</updated_at>\n\t</vendor>\n</purchase>"}}},"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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"note":{"type":"string","example":"Audit note"}}}}}},"example":"<>\n\t<audit>\n\t\t<id>1</id>\n\t\t<message>State changed from New to On Hold</message>\n\t\t<action>Update</action>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t\t<source_type>Incident</source_type>\n\t\t<source_id>1</source_id>\n\t\t<user_id>1</user_id>\n\t\t<user>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</user>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<note>Audit note</note>\n\t</audit>\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}]},"default_group_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}]},"default_group_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"note":{"type":"string","example":"Audit note"}}}}}},"example":"<>\n\t<audit>\n\t\t<id>1</id>\n\t\t<message>State changed from New to On Hold</message>\n\t\t<action>Update</action>\n\t\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t\t<source_type>Incident</source_type>\n\t\t<source_id>1</source_id>\n\t\t<user_id>1</user_id>\n\t\t<user>\n\t\t\t<id>1</id>\n\t\t\t<account_id>1</account_id>\n\t\t\t<user_id>1</user_id>\n\t\t\t<email>john.doe@email.com</email>\n\t\t\t<name>John Doe</name>\n\t\t\t<disabled>true</disabled>\n\t\t\t<avatar>\n\t\t\t\t<type>initials</type>\n\t\t\t\t<color>#1000</color>\n\t\t\t\t<initials>JD</initials>\n\t\t\t</avatar>\n\t\t</user>\n\t\t<site>\n\t\t\t<id>1</id>\n\t\t\t<name>Austin TX, USA</name>\n\t\t\t<description>AUS</description>\n\t\t\t<location>AUS</location>\n\t\t\t<timezone>UTC-6h</timezone>\n\t\t</site>\n\t\t<department>\n\t\t\t<id>1</id>\n\t\t\t<name>Support</name>\n\t\t\t<description>Support Department</description>\n\t\t\t<default_assignee_id>1</default_assignee_id>\n\t\t\t<default_group_assignee_id>1</default_group_assignee_id>\n\t\t</department>\n\t\t<note>Audit note</note>\n\t</audit>\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\t<id>1</id>\n\t<name>Risk name</name>\n\t<severity>Medium</severity>\n\t<category>Inventory</category>\n\t<discarded>true</discarded>\n\t<resolved>true</resolved>\n\t<affected_assets>\n\t\t<id>1</id>\n\t\t<name>Computer name</name>\n\t\t<type>Hardware</type>\n\t</affected_assets>\n\t<created_at>2025-01-01T00:00:00.000+01:00</created_at>\n\t<updated at>2025-01-01T00:00:00.000+01:00</updated at>\n\n<>"}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/attachments":{"post":{"operationId":"createAttachment","description":"Create a new attachment: <p>curl -H 'X-Samanage-Authorization: Bearer TOKEN' <br>-F 'file[attachable_type]=PARENT_OBJECT_TYPE' <br>-F 'file[attachable_id]=PARENT_OBJECT_ID' <br>-F 'file[attachment]=@/PATH/TO/FILE' <br>-H 'Accept: application/vnd.samanage.v1.3+xml' <br>-H 'Content-Type: multipart/form-data' <br>-X POST https://api.samanage.com/attachments.xml/json </p>","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":"Change Request","description":"Requesting a change"},{"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"}]}