@itentialopensource/adapter-solarwinds_servicedesk

openapi: 3.0.0 info: title: SolarWinds Service Desk API description: "All SolarWinds Service Desk API definitions\n# General Concepts\n## Service URL\nFor US based customers, please use `https://api.samanage.com`\n\n For European based customers, please use `https://apieu.samanage.com`\n\n## Formats\n\nYou can use XML or JSON format for your request.\n\nXML Example: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+xml\" -X GET https://api.samanage.com/incidents.xml`\n\nJSON Example: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+json\" -H \"Content-Type: application/json\" -X GET https://api.samanage.com/incidents.json`\n\nFor create and update, the provided data needs to be in the correct format.\n\nXML Example: `<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. 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\nTo ensure API performance and avoid denial of service, we employ API call limits based per minute as defined by the Service Desk plan of the endpoint user.\n\nPackages:\n\nProfessional Plan - 1000 calls per minute\n\nEnterprise Plan - 1500 calls per minute\n## Versioning\nClients must provide the version number they are ready to work with in the “Accept” HTTP header. A valid \"Accept\" header should specify current content type and version number. For example, “application/vnd.samanage.v2.1+xml”.\n When no “Accept” header is specified, the API will default to version 2.1.\nIf you request an API version that is no longer supported, the API will respond with an HTTP status code of “406 – Not Acceptable”.\n\nExample: \n`curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+json\" https://api.samanage.com/hardwares.json`\n## Version History\n* 1.0: Deprecated\n* 1.1: Changed structure of custom_fields_values\n* 1.2: Changed name of “incident_type” to “category” in Catalog items and Incidents\n* 1.3: Updates to incidents or comments will not send an email or a notification to the users. To enable this feature you must add add_callbacks=true to the url.\n* 2.1: Token based authentication\n## Pagination\nEvery response with a large data set will be paginated. The response will include the pagination data as headers and links (formatted as <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\"}]}}}`<br><br><hr></hr>" contact: name: API Support url: https://support.solarwinds.com email: servicedesksupport@solarwinds.com version: '0.1.5' servers: - url: https://api.samanage.com variables: {} - url: https://apieu.samanage.com variables: {} paths: /incidents/{id}: get: tags: - Incident summary: getIncidentById description: Get incident operationId: getIncidentById parameters: - name: X-Samanage-Authorization in: header description: '' style: simple schema: type: string example: Bearer TOKEN - name: id in: path description: Numeric ID of the object to get or update required: true style: simple schema: type: string responses: '200': description: Object was returned correctly headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/IncidentsResponse' - example: incident: id: '10000' number: '1000' name: Incident Name description: description state: New site: id: '1' name: Austin TX, USA location: AUS description: '' time_zone: '' department: id: '1' name: Support description: '' default_assignee_id: '1' category: id: '10000' name: Facilities default_tags: tagA, tagB parent_id: 'null' default_assignee_id: '1' subcategory: id: '1000' name: Equipment default_tags: '' parent_id: '10000' default_assignee_id: '1' priority: High assignee: group_id: '1' is_user: 'true' id: '1' name: John Doe email: john.doe@email.com avatar: type: initials color: '#fd4165' initials: JD requester: id: '1' account_id: '1' user_id: '1' email: john.doe@email.com name: John Doe disabled: false avatar: type: initials color: '#fd4165' initials: JD custom_fields_values: - id: '10' custom_field_id: '1' name: Text custom field value: content options: '' type_name: Text - id: '100' custom_field_id: '2' name: User custom field value: '1' options: '' type_name: User user: group_id: 1 is_user: true id: 1 name: John Doe email: john.doe@email.com due_at: 2025-01-01T00:00:00.000+01:00 origin: api incidents: - id: '100' href: https://mydomain.com/incidents/100 problems: - id: '100' href: https://mydomain.com/problems/100 changes: - id: '100' href: https://mydomain.com/changes/100 solutions: - id: '100' href: https://mydomain.com/solutions/100 releases: - id: '100' href: https://mydomain.com/releases/100 configuration_items: - id: '100' href: https://mydomain.com/configuration_items/100 is_service_request: false cc: - jane.doe@email.com example: incident: id: '10000' number: '1000' name: Incident Name description: description state: New site: id: '1' name: Austin TX, USA location: AUS description: '' time_zone: '' department: id: '1' name: Support description: '' default_assignee_id: '1' category: id: '10000' name: Facilities default_tags: tagA, tagB parent_id: 'null' default_assignee_id: '1' subcategory: id: '1000' name: Equipment default_tags: '' parent_id: '10000' default_assignee_id: '1' priority: High assignee: group_id: '1' is_user: 'true' id: '1' name: John Doe email: john.doe@email.com avatar: type: initials color: '#fd4165' initials: JD requester: id: '1' account_id: '1' user_id: '1' email: john.doe@email.com name: John Doe disabled: false avatar: type: initials color: '#fd4165' initials: JD custom_fields_values: - id: '10' custom_field_id: '1' name: Text custom field value: content options: '' type_name: Text - id: '100' custom_field_id: '2' name: User custom field value: '1' options: '' type_name: User user: group_id: 1 is_user: true id: 1 name: John Doe email: john.doe@email.com due_at: 2025-01-01T00:00:00.000+01:00 origin: api incidents: - id: '100' href: https://mydomain.com/incidents/100 problems: - id: '100' href: https://mydomain.com/problems/100 changes: - id: '100' href: https://mydomain.com/changes/100 solutions: - id: '100' href: https://mydomain.com/solutions/100 releases: - id: '100' href: https://mydomain.com/releases/100 configuration_items: - id: '100' href: https://mydomain.com/configuration_items/100 is_service_request: false cc: - jane.doe@email.com application/xml: schema: allOf: - $ref: '#/components/schemas/IncidentsResponse' - xml: name: _ attribute: false wrapped: false example: <_ /> example: <_ /> '400': description: Bad request headers: {} content: {} '404': description: Not found headers: {} content: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false put: tags: - Incident summary: updateIncidentById description: Update incident with specified fields operationId: updateIncidentById parameters: - name: X-Samanage-Authorization in: header description: '' style: simple schema: type: string example: Bearer TOKEN - name: id in: path description: Numeric ID of the object to get or update required: true style: simple schema: type: string requestBody: description: Incident fields to update content: application/json: schema: allOf: - $ref: '#/components/schemas/IncidentsRequest' - description: Incident fields to update example: incident: name: Incident Name site_id: 1 department_id: 1 description: description state_id: 1 assignee: email: john.doe@email.com requester: email: john.doe@email.com priority: High category: name: Facilities subcategory: name: Equipment due_at: Jan 01,2025 add_to_tag_list: tag1, tag2 remove_from_tag_list: tag3 tag_list: tag1, tag2 custom_fields_values_attributes: - id: 10 custom_field_id: 1 value: content - id: 100 custom_field_id: 2 value: '1' custom_fields_values: custom_fields_value: - name: Text custom field value: content - name: User custom field user_value: email: john.doe@email.com incidents: - number: '100' problems: - number: '100' changes: - number: '100' solutions: - number: '100' releases: - number: '100' configuration_item_ids: - '100' cc: - jane.doe@email.com example: incident: name: Incident Name site_id: 1 department_id: 1 description: description state_id: 1 assignee: email: john.doe@email.com requester: email: john.doe@email.com priority: High category: name: Facilities subcategory: name: Equipment due_at: Jan 01,2025 add_to_tag_list: tag1, tag2 remove_from_tag_list: tag3 tag_list: tag1, tag2 custom_fields_values_attributes: - id: 10 custom_field_id: 1 value: content - id: 100 custom_field_id: 2 value: '1' custom_fields_values: custom_fields_value: - name: Text custom field value: content - name: User custom field user_value: email: john.doe@email.com incidents: - number: '100' problems: - number: '100' changes: - number: '100' solutions: - number: '100' releases: - number: '100' configuration_item_ids: - '100' cc: - jane.doe@email.com required: true responses: '200': description: Object was updated correctly headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/IncidentsResponse2' - example: incident: id: '10000' number: '1000' name: Incident Name description: description state: New site: id: '1' name: Austin TX, USA location: AUS description: '' time_zone: '' department: id: '1' name: Support description: '' default_assignee_id: '1' category: id: '10000' name: Facilities default_tags: tagA, tagB parent_id: 'null' default_assignee_id: '1' subcategory: id: '1000' name: Equipment default_tags: '' parent_id: '10000' default_assignee_id: '1' priority: High assignee: group_id: '1' is_user: 'true' id: '1' name: John Doe email: john.doe@email.com avatar: type: initials color: '#fd4165' initials: JD requester: id: '1' account_id: '1' user_id: '1' email: john.doe@email.com name: John Doe disabled: false avatar: type: initials color: '#fd4165' initials: JD custom_fields_values: - id: '10' custom_field_id: '1' name: Text custom field value: content options: '' type_name: Text - id: '100' custom_field_id: '2' name: User custom field value: '1' options: '' type_name: User user: group_id: 1 is_user: true id: 1 name: John Doe email: john.doe@email.com due_at: 2025-01-01T00:00:00.000+01:00 origin: api incidents: - id: '100' href: https://mydomain.com/incidents/100 problems: - id: '100' href: https://mydomain.com/problems/100 changes: - id: '100' href: https://mydomain.com/changes/100 solutions: - id: '100' href: https://mydomain.com/solutions/100 releases: - id: '100' href: https://mydomain.com/releases/100 configuration_items: - id: '100' href: https://mydomain.com/configuration_items/100 is_service_request: false cc: - jane.doe@email.com example: incident: id: '10000' number: '1000' name: Incident Name description: description state: New site: id: '1' name: Austin TX, USA location: AUS description: '' time_zone: '' department: id: '1' name: Support description: '' default_assignee_id: '1' category: id: '10000' name: Facilities default_tags: tagA, tagB parent_id: 'null' default_assignee_id: '1' subcategory: id: '1000' name: Equipment default_tags: '' parent_id: '10000' default_assignee_id: '1' priority: High assignee: group_id: '1' is_user: 'true' id: '1' name: John Doe email: john.doe@email.com avatar: type: initials color: '#fd4165' initials: JD requester: id: '1' account_id: '1' user_id: '1' email: john.doe@email.com name: John Doe disabled: false avatar: type: initials color: '#fd4165' initials: JD custom_fields_values: - id: '10' custom_field_id: '1' name: Text custom field value: content options: '' type_name: Text - id: '100' custom_field_id: '2' name: User custom field value: '1' options: '' type_name: User user: group_id: 1 is_user: true id: 1 name: John Doe email: john.doe@email.com due_at: 2025-01-01T00:00:00.000+01:00 origin: api incidents: - id: '100' href: https://mydomain.com/incidents/100 problems: - id: '100' href: https://mydomain.com/problems/100 changes: - id: '100' href: https://mydomain.com/changes/100 solutions: - id: '100' href: https://mydomain.com/solutions/100 releases: - id: '100' href: https://mydomain.com/releases/100 configuration_items: - id: '100' href: https://mydomain.com/configuration_items/100 is_service_request: false cc: - jane.doe@email.com application/xml: schema: allOf: - $ref: '#/components/schemas/IncidentsResponse2' - xml: name: _ attribute: false wrapped: false example: <_ /> example: <_ /> '400': description: Bad request headers: {} content: {} '404': description: Not found headers: {} content: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false delete: tags: - Incident summary: deleteIncidentById description: Delete incident operationId: deleteIncidentById parameters: - name: X-Samanage-Authorization in: header description: '' style: simple schema: type: string example: Bearer TOKEN - name: id in: path description: Numeric ID of the object to get or update required: true style: simple schema: type: string responses: '200': description: Returns the deleted incident's id headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/IncidentsResponse4' - example: deleted_ids: - '1' example: deleted_ids: - '1' '400': description: Bad request headers: {} content: {} '404': description: Not found headers: {} content: {} '500': description: Internal Server Error headers: {} content: {} deprecated: false /incidents: get: tags: - Incident summary: getIncidents description: List of incidents operationId: getIncidents parameters: - name: X-Samanage-Authorization in: header description: '' style: simple schema: type: string example: Bearer TOKEN responses: '200': description: Object was returned correctly headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/IncidentsResponse2' description: List of incidents example: - incident: id: '10000' number: '1000' name: Incident Name description: description state: New site: id: '1' name: Austin TX, USA location: AUS description: '' time_zone: '' department: id: '1' name: Support description: '' default_assignee_id: '1' category: id: '10000' name: Facilities default_tags: tagA, tagB parent_id: 'null' default_assignee_id: '1' subcategory: id: '1000' name: Equipment default_tags: '' parent_id: '10000' default_assignee_id: '1' priority: High assignee: group_id: '1' is_user: 'true' id: '1' name: John Doe email: john.doe@email.com avatar: type: initials color: '#fd4165' initials: JD requester: id: '1' account_id: '1' user_id: '1' email: john.doe@email.com name: John Doe disabled: false avatar: type: initials color: '#fd4165' initials: JD custom_fields_values: - id: '10' custom_field_id: '1' name: Text custom field value: content options: '' type_name: Text - id: '100' custom_field_id: '2' name: User custom field value: '1' options: '' type_name: User user: group_id: 1 is_user: true id: 1 name: John Doe email: john.doe@email.com due_at: 2025-01-01T00:00:00.000+01:00 origin: api incidents: - id: '100' href: https://mydomain.com/incidents/100 problems: - id: '100' href: https://mydomain.com/problems/100 changes: - id: '100' href: https://mydomain.com/changes/100 solutions: - id: '100' href: https://mydomain.com/solutions/100 releases: - id: '100' href: https://mydomain.com/releases/100 configuration_items: - id: '100' href: https://mydomain.com/configuration_items/100 is_service_request: false cc: - jane.doe@email.com example: - incident: id: '10000' number: '1000' name: Incident Name description: description state: New site: id: '1' name: Austin TX, USA location: AUS description: '' time_zone: '' department: id: '1' name: Support description: '' default_assignee_id: '1' category: id: '10000' name: Facilities default_tags: tagA, tagB parent_id: 'null' default_assignee_id: '1' subcategory: id: '1000' name: Equipment default_tags: '' parent_id: '10000' default_assignee_id: '1' priority: High assignee: group_id: '1' is_user: 'true' id: '1' name: John Doe email: john.doe@email.com avatar: type: initials color: '#fd4165' initials: JD requester: id: '1' account_id: '1' user_id: '1' email: john.doe@email.com name: John Doe disabled: false avatar: type: initials color: '#fd4165' initials: JD custom_fields_values: - id: '10' custom_field_id: '1' name: Text custom field value: content options: '' type_name: Text - id: '100' custom_field_id: '2' name: User custom field value: '1' options: '' type_name: User user: group_id: 1 is_user: true id: 1 name: John Doe email: john.doe@email.com due_at: 2025-01-01T00:00:00.000+01:00 origin: api incidents: - id: '100' href: https://mydomain.com/incidents/100 problems: - id: '100' href: https://mydomain.com/problems/100 changes: - id: '100' href: https://mydomain.com/changes/100 solutions: - id: '100' href: https://mydomain.com/solutions/100 releases: - id: '100' href: https://mydomain.com/releases/100 configuration_items: - id: '100' href: https://mydomain.com/configuration_items/100 is_service_request: false cc: - jane.doe@email.com application/xml: schema: type: array items: $ref: '#/components/schemas/IncidentsResponse2' description: List of incidents xml: name: / attribute: false wrapped: true '400': description: Bad request headers: {} content: {} '404': description: Not found headers: {} content: {} '500': description: Server error headers: {} content: {} deprecated: false post: tags: - Incident summary: createIncident description: Create new incident operationId: createIncident parameters: - name: X-Samanage-Authorization in: header description: '' style: simple schema: type: string example: Bearer TOKEN requestBody: description: Incident fields to fill content: application/json: schema: allOf: - $ref: '#/components/schemas/IncidentsRequest1' - description: Incident fields to fill example: incident: name: Incident Name site_id: 1 department_id: 1 description: description state_id: 1 assignee: email: john.doe@email.com requester: email: john.doe@email.com priority: High category: name: Facilities subcategory: name: Equipment due_at: Jan 01,2025 add_to_tag_list: tag1, tag2 remove_from_tag_list: tag3 tag_list: tag1, tag2 custom_fields_values_attributes: - id: 10 custom_field_id: 1 value: content - id: 100 custom_field_id: 2 value: '1' custom_fields_values: custom_fields_value: - name: Text custom field value: content - name: User custom field user_value: email: john.doe@email.com incidents: - number: '100' problems: - number: '100' changes: - number: '100' solutions: - number: '100' releases: - number: '100' configuration_item_ids: - '100' cc: - jane.doe@email.com example: incident: name: Incident Name site_id: 1 department_id: 1 description: description state_id: 1 assignee: email: john.doe@email.com requester: email: john.doe@email.com priority: High category: name: Facilities subcategory: name: Equipment due_at: Jan 01,2025 add_to_tag_list: tag1, tag2 remove_from_tag_list: tag3 tag_list: tag1, tag2 custom_fields_values_attributes: - id: 10 custom_field_id: 1 value: content - id: 100 custom_field_id: 2 value: '1' custom_fields_values: custom_fields_value: - name: Text custom field value: content - name: User custom field user_value: email: john.doe@email.com incidents: - number: '100' problems: - number: '100' changes: - number: '100' solutions: - number: '100' releases: - number: '100' configuration_item_ids: - '100' cc: - jane.doe@email.com required: true responses: '200': description: Object created and returned correctly headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/IncidentsResponse2' - example: incident: id: '10000' number: '1000' name: Incident Name description: description state: New site: id: '1' name: Austin TX, USA location: AUS description: '' time_zone: '' department: id: '1' name: Support description: '' default_assignee_id: '1' category: id: '10000' name: Facilities default_tags: tagA, tagB parent_id: 'null' default_assignee_id: '1' subcategory: id: '1000' name: Equipment default_tags: '' parent_id: '10000' default_assignee_id: '1' priority: High assignee: group_id: '1' is_user: 'true' id: '1' name: John Doe email: john.doe@email.com avatar: type: initials color: '#fd4165' initials: JD requester: id: '1' account_id: '1' user_id: '1' email: john.doe@email.com name: John Doe disabled: false avatar: type: initials color: '#fd4165' initials: JD custom_fields_values: - id: '10' custom_field_id: '1' name: Text custom field value: content options: '' type_name: Text - id: '100' custom_field_id: '2' name: User custom field value: '1' options: '' type_name: User user: group_id: 1 is_user: true id: 1 name: John Doe email: john.doe@email.com due_at: 2025-01-01T00:00:00.000+01:00 origin: api incidents: - id: '100' href: https://mydomain.com/incidents/100 problems: - id: '100' href: https://mydomain.com/problems/100 changes: - id: '100' href: https://mydomain.com/changes/100 solutions: - id: '100' href: https://mydomain.com/solutions/100 releases: - id: '100' href: https://mydomain.com/releases/100 configuration_items: - id: '100' href: https://mydomain.com/configuration_items/100 is_service_request: false cc: - jane.doe@email.com example: incident: id: '10000' number: '1000' name: Incident Name description: description state: New site: id: '1' name: Austin TX, USA location: AUS description: '' time_zone: '' department: id: '1' name: Support description: '' default_assignee_id: '1' category: id: '10000' name: Facilities default_tags: tagA, tagB parent_id: 'null' default_assignee_id: '1' subcategory: id: '1000' name: Equipment default_tags: '' parent_id: '10000' default_assignee_id: '1' priority: High assignee: group_id: '1' is_user: 'true' id: '1' name: John Doe email: john.doe@email.com avatar: type: initials color: '#fd4165' initials: JD requester: id: '1' account_id: '1' user_id: '1' email: john.doe@email.com name: John Doe disabled: false avatar: type: initials color: '#fd4165' initials: JD custom_fields_values: - id: '10' custom_field_id: '1' name: Text custom field value: content options: '' type_name: Text - id: '100' custom_field_id: '2' name: User custom field value: '1' options: '' type_name: User user: group_id: 1 is_user: true id: 1 name: John Doe email: john