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: ` content `\n\nJSON Example: `{\"incident\": {\"field_to_update\": \"content\"}}`\n\nTo clear fields, use the following format:\n\nXML Example: ` `\n\nJSON Example: `{\"incident\": {\"field_to_update\": \"\"}}`\n\n## Authentication\nThe API authentication is token-based. Admins can generate a token directly from the user setup page. The token is needed by the API developer to gain access to specific items in SolarWinds accessible only via the API. When an admin re-generates their token (via the user setup page), all previously generated tokens become invalid.\n\nThe tokens are relatively long strings that resemble the following: AAAZWV0YXkubmF0YW4rNUBzYW1hbmFnZS5jb20hbGciOiJIUzUxMiJ9.eyJ1c2VyX2ljIjoxMjU2OTQzLCJnZW5lcmF0ZWRfYXQiOiIyMDE3LTA2LTA3IDA5OjE3OjI5In0.j_H15qzJJr9vXGAHCThLEOQrE9GGbjMxZJOs5zAf_iqaGqxlIOAmvPpBx0td_C3r7dliAfXXIgdqhZHVoK1KTwAzd1
\n\nIn order to supply the API token you should pass X-Samanage-Authorization header in the following format: “Bearer API_TOKEN_STRING”.\n\nThe API call resembles the following:\n\n`curl -H \"X-Samanage-Authorization: Bearer AAAZWV0YXkubmF0YW4rNUBzYW1hbmFnZS5jb20hbGciOiJIUzUxMiJ9.eyJ1c2VyX2ljIjoxMjU2OTQzLCJnZW5lcmF0ZWRfYXQiOiIyMDE3LTA2LTA3IDA5OjE3OjI5In0.j_H15qzJJr9vXGAHCThLEOQrE9GGbjMxZJOs5zAf_iqaGqxlIOAmvPpBx0td_C3r7dliAfXXIgdqhZHVoK1KTwAzd1\" -H \"Accept: application/vnd.samanage.v2.1+json\" https://api.samanage.com/hardwares.json`\n\nIf the authentication fails, a “401 Unauthorized” message will be returned.\n## Security\nSWSD uses a secured API channel. To connect to the regional API server, use the account admin users’ token information and connect using Token-based authentication. Requests should never be transferred in plain text over the wire. Instead, use SSL version 1.2 or higher (which can be accessed using https://) to ensure that all communication with the server is encrypted and secured.\n\nTo ensure API performance and avoid denial of service, we employ API call limits based per minute as defined by the Service Desk plan of the endpoint user.\n\nPackages:\n\nProfessional Plan - 1000 calls per minute\n\nEnterprise Plan - 1500 calls per minute\n## Versioning\nClients must provide the version number they are ready to work with in the “Accept” HTTP header. A valid \"Accept\" header should specify current content type and version number. For example, “application/vnd.samanage.v2.1+xml”.\n When no “Accept” header is specified, the API will default to version 2.1.\nIf you request an API version that is no longer supported, the API will respond with an HTTP status code of “406 – Not Acceptable”.\n\nExample: \n`curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/vnd.samanage.v2.1+json\" https://api.samanage.com/hardwares.json`\n## Version History\n* 1.0: Deprecated\n* 1.1: Changed structure of custom_fields_values\n* 1.2: Changed name of “incident_type” to “category” in Catalog items and Incidents\n* 1.3: Updates to incidents or comments will not send an email or a notification to the users. To enable this feature you must add add_callbacks=true to the url.\n* 2.1: Token based authentication\n## Pagination\nEvery response with a large data set will be paginated. The response will include the pagination data as headers and links (formatted as ; rel=”relative”). For example:\n\nX-Per-Page: 50\n\nX-Total-Count: 3099\n\nX-Total-Pages: 62\n\nLink: ``; rel=\"first\",\n\n``; rel=\"prev\",\n\n``; rel=\"next\",\n\n``; rel=\"last\"\n\nYou can request a specific page by providing a “page” parameter. For example, to request the third page of the hardware list, you can use the following command: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" https://api.samanage.com/hardwares.json?page=3`\n\nTo control the number of rows returned, provide the per_page parameter. For example, to request 100 rows with each results page, you can use the following command: `curl -H \"X-Samanage-Authorization: Bearer TOKEN\" https://api.samanage.com/hardwares.json?per_page=100`\n## API Entry Point\n All communication with the API begins with a list of available services. Although it is possible to get directly to a specific service URL, we advise you begin with the api.xml entry point. This ensures your program will run seamlessly if changes are made to the underlying URLs for services in future versions of the API.\n\n**Request**\n\nGET api.samanage.com/api.json \n`curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H \"Accept: application/json\" -X GET https://api.samanage.com/api.json`\n\n**Response**\n\n`[{\"name\":\"Computers List\",\"href\":\"https://api.samanage.com/hardwares.json\"},`\n\n`{\"name\":\"Helpdesk Incidents List\",\"href\":\"https://api.samanage.com/incidents.json\"},`\n\n`{\"name\":\"Changes List\",\"href\":\"https://api.samanage.com/changes.json\"},`\n\n`...]`\n## Short / long layout\nFor all APIs, you can specify the layout (short / long). This affects the length of the returned records, and is relevant for changes, contracts, hardwares, incidents, other assets, problems, and solutions.\n\nTo use, add the parameter to the request: “?layout=short” or “?layout=long”. If not present, the default is “short”.\n## Searching\nYou can search for records by using query parameters on top of the base URL. For example, when requesting a list of hardwares, you may want to limit them to only those with a specific IP address. This could be accomplished with a request like -\n\n GET api.samanage.com/hardwares.xml?ip_address=123.456*\n\nHere, ip_address is a query parameter that implements a filter where the IP equals 123.456.xxx.xxx.\n\nOther examples: `https://api.samanage.com/other_assets.json?asset_id=XXXXXXXX`, `https://api.samanage.com/hardwares.json?asset_tag=XXXXXXXX`\n## Date formats\nThe following date formats are allowed as input when updating date fields:\n\n* January 21, 2015\n* January 21 2015\n* Jan 21, 2015\n* Jan 21 2015\n* 21/1/2015\n* 2015/1/21\n* 21-1-2015\n* 2015-1-21\n*21.1.2015 \n* 2015.1.21\n## Custom fields\nTo set custom fields, use the following data format:\n\n XML Example:\n\n``\n\n`field namecontent`\n\n``\n\nJSON Example:\n\n`{\"incident\": {\"custom_fields_values\": {\"custom_fields_value\": [{\"name\": \"field name\",\"value\": \"content\"}]}}}`
"
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.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: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/problems/{id}:
get:
tags:
- Problem
summary: getProblemById
description: Get problem
operationId: getProblemById
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/ProblemsResponse'
- example:
problem:
id: '10000'
number: '1000'
name: Problem Name
description: description
state: New
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
problem:
id: '10000'
number: '1000'
name: Problem Name
description: description
state: New
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ProblemsResponse'
- 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:
- Problem
summary: updateProblemById
description: Update problem with specified fields
operationId: updateProblemById
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: Problem fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProblemsRequest'
- description: Problem fields to update
example:
problem:
name: Problem Name
site_id: 1
department_id: 1
description: description
state: '1'
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
incident_ids:
- 100
itsm_change_ids:
- 100
configuration_item_ids:
- 100
example:
problem:
name: Problem Name
site_id: 1
department_id: 1
description: description
state: '1'
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
incident_ids:
- 100
itsm_change_ids:
- 100
configuration_item_ids:
- 100
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProblemsResponse'
- example:
problem:
id: '10000'
number: '1000'
name: Problem Name
description: description
state: New
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
problem:
id: '10000'
number: '1000'
name: Problem Name
description: description
state: New
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ProblemsResponse'
- 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:
- Problem
summary: deleteProblemById
description: Delete problem
operationId: deleteProblemById
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 problem's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProblemsResponse4'
- 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
/problems:
get:
tags:
- Problem
summary: getProblems
description: List of problems
operationId: getProblems
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/ProblemsResponse'
description: List of problems
example:
- problem:
id: '10000'
number: '1000'
name: Problem Name
description: description
state: New
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
- problem:
id: '10000'
number: '1000'
name: Problem Name
description: description
state: New
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/ProblemsResponse'
description: List of problems
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:
- Problem
summary: createProblem
description: Create new problem
operationId: createProblem
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Problem fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProblemsRequest1'
- description: Problem fields to fill
example:
problem:
name: Problem Name
site_id: 1
department_id: 1
description: description
state: '1'
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
incident_ids:
- 100
itsm_change_ids:
- 100
configuration_item_ids:
- 100
example:
problem:
name: Problem Name
site_id: 1
department_id: 1
description: description
state: '1'
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
incident_ids:
- 100
itsm_change_ids:
- 100
configuration_item_ids:
- 100
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProblemsResponse'
- example:
problem:
id: '10000'
number: '1000'
name: Problem Name
description: description
state: New
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
problem:
id: '10000'
number: '1000'
name: Problem Name
description: description
state: New
root_cause: Root cause description
symptoms: Symptoms description
workaround: workaround description
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ProblemsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/changes/{id}:
get:
tags:
- Change
summary: getChangeById
description: Get change
operationId: getChangeById
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/ChangesResponse'
- example:
change:
id: '10000'
number: '1000'
name: Change Name
description: description
state: New
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
change:
id: '10000'
number: '1000'
name: Change Name
description: description
state: New
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ChangesResponse'
- 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:
- Change
summary: updateChangeById
description: Update change with specified fields
operationId: updateChangeById
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: Change fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangesRequest'
- description: Change fields to update
example:
change:
name: Change Name
change_type: 1
site_id: 1
department_id: 1
description: description
state_id: 1
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01 00:00
planned_end_at: 2025-01-01 05:00
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
incidents:
- number: '100'
problems:
- number: '100'
releases:
- number: '100'
configuration_item_ids:
- '100'
example:
change:
name: Change Name
change_type: 1
site_id: 1
department_id: 1
description: description
state_id: 1
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01 00:00
planned_end_at: 2025-01-01 05:00
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
incidents:
- number: '100'
problems:
- number: '100'
releases:
- number: '100'
configuration_item_ids:
- '100'
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangesResponse'
- example:
change:
id: '10000'
number: '1000'
name: Change Name
description: description
state: New
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
change:
id: '10000'
number: '1000'
name: Change Name
description: description
state: New
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ChangesResponse'
- 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:
- Change
summary: deleteChangeById
description: Delete change
operationId: deleteChangeById
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 change's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangesResponse4'
- 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
/changes:
get:
tags:
- Change
summary: getChanges
description: List of changes
operationId: getChanges
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/ChangesResponse'
description: List of changes
example:
- change:
id: '10000'
number: '1000'
name: Change Name
description: description
state: New
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
- change:
id: '10000'
number: '1000'
name: Change Name
description: description
state: New
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/ChangesResponse'
description: List of changes
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:
- Change
summary: createChange
description: Create new change
operationId: createChange
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Change fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangesRequest1'
- description: Change fields to fill
example:
change:
name: Change Name
change_type: 1
site_id: 1
department_id: 1
description: description
state_id: 1
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01 00:00
planned_end_at: 2025-01-01 05:00
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
incidents:
- number: '100'
problems:
- number: '100'
releases:
- number: '100'
configuration_item_ids:
- '100'
example:
change:
name: Change Name
change_type: 1
site_id: 1
department_id: 1
description: description
state_id: 1
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01 00:00
planned_end_at: 2025-01-01 05:00
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
incidents:
- number: '100'
problems:
- number: '100'
releases:
- number: '100'
configuration_item_ids:
- '100'
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangesResponse'
- example:
change:
id: '10000'
number: '1000'
name: Change Name
description: description
state: New
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
change:
id: '10000'
number: '1000'
name: Change Name
description: description
state: New
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ChangesResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/change_catalogs/{id}:
get:
tags:
- Change Catalog
summary: getChangeCatalogById
description: Get change catalog
operationId: getChangeCatalogById
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/ChangeCatalogsResponse'
- example:
change_catalog:
id: '1'
number: '1'
name: Change Catalog Name
description: description
state: Approved
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
default_assignee_id: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
show_in_portal: true
example:
change_catalog:
id: '1'
number: '1'
name: Change Catalog Name
description: description
state: Approved
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
default_assignee_id: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
show_in_portal: true
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ChangeCatalogsResponse'
- 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:
- Change Catalog
summary: updateChangeCatalogById
description: Update change catalog with specified fields
operationId: updateChangeCatalogById
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: Change catalog fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangeCatalogsRequest'
- description: Change catalog fields to update
example:
change_catalog:
name: Change Catalog Name
change_type: 1
site_id: 1
department_id: 1
description: description
state_id: 1
default_assignee_id: 1
priority: High
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
show_in_portal: true
example:
change_catalog:
name: Change Catalog Name
change_type: 1
site_id: 1
department_id: 1
description: description
state_id: 1
default_assignee_id: 1
priority: High
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
show_in_portal: true
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangeCatalogsResponse'
- example:
change_catalog:
id: '1'
number: '1'
name: Change Catalog Name
description: description
state: Approved
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
default_assignee_id: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
show_in_portal: true
example:
change_catalog:
id: '1'
number: '1'
name: Change Catalog Name
description: description
state: Approved
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
default_assignee_id: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
show_in_portal: true
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ChangeCatalogsResponse'
- 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:
- Change Catalog
summary: deleteChangeCatalogById
description: Delete change catalog
operationId: deleteChangeCatalogById
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 change catalog's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangeCatalogsResponse4'
- 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
/change_catalogs:
get:
tags:
- Change Catalog
summary: getChangeCatalogs
description: List of change catalogs
operationId: getChangeCatalogs
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/ChangeCatalogsResponse'
description: List of change catalogs
example:
- change_catalog:
id: '1'
number: '1'
name: Change Catalog Name
description: description
state: Approved
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
default_assignee_id: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
show_in_portal: true
example:
- change_catalog:
id: '1'
number: '1'
name: Change Catalog Name
description: description
state: Approved
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
default_assignee_id: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
show_in_portal: true
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/ChangeCatalogsResponse'
description: List of change catalogs
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:
- Change Catalog
summary: createChangeCatalog
description: Create new change catalog
operationId: createChangeCatalog
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Change catalog fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangeCatalogsRequest1'
- description: Change catalog fields to fill
example:
change_catalog:
name: Change Catalog Name
change_type: 1
site_id: 1
department_id: 1
description: description
state_id: 1
default_assignee_id: 1
priority: High
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
show_in_portal: true
example:
change_catalog:
name: Change Catalog Name
change_type: 1
site_id: 1
department_id: 1
description: description
state_id: 1
default_assignee_id: 1
priority: High
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
show_in_portal: true
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ChangeCatalogsResponse'
- example:
change_catalog:
id: '1'
number: '1'
name: Change Catalog Name
description: description
state: Approved
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
default_assignee_id: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
show_in_portal: true
example:
change_catalog:
id: '1'
number: '1'
name: Change Catalog Name
description: description
state: Approved
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
priority: High
default_assignee_id: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
change_plan: change plan
rollback_plan: rollback plan
test_plan: test plan
origin: api
created_at: 2025-01-01T00:00:00.000+01:00
show_in_portal: true
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ChangeCatalogsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/releases/{id}:
get:
tags:
- Release
summary: getReleaseById
description: Get release
operationId: getReleaseById
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/ReleasesResponse'
- example:
release:
id: '10000'
number: '1000'
name: Release Name
description: description
state: New
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: Austin TX, USA
department:
id: '1'
name: Support
description: Support Department
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
approvers:
- group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
release:
id: '10000'
number: '1000'
name: Release Name
description: description
state: New
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: Austin TX, USA
department:
id: '1'
name: Support
description: Support Department
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
approvers:
- group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ReleasesResponse'
- 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:
- Release
summary: updateReleaseById
description: Update release with specified fields
operationId: updateReleaseById
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: Release fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ReleasesRequest'
- description: Release fields to update
example:
release:
name: Release Name
site_id: 1
department_id: 1
description: description
state: '1'
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01 00:00
planned_end_at: 2025-01-01 05:00
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
approval_levels_attributes:
- id: '1'
approver_ids: '1'
approval_condition: '1'
itsm_change_ids:
- 100
configuration_item_ids:
- 100
example:
release:
name: Release Name
site_id: 1
department_id: 1
description: description
state: '1'
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01 00:00
planned_end_at: 2025-01-01 05:00
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
approval_levels_attributes:
- id: '1'
approver_ids: '1'
approval_condition: '1'
itsm_change_ids:
- 100
configuration_item_ids:
- 100
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ReleasesResponse'
- example:
release:
id: '10000'
number: '1000'
name: Release Name
description: description
state: New
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: Austin TX, USA
department:
id: '1'
name: Support
description: Support Department
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
approvers:
- group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
release:
id: '10000'
number: '1000'
name: Release Name
description: description
state: New
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: Austin TX, USA
department:
id: '1'
name: Support
description: Support Department
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
approvers:
- group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ReleasesResponse'
- 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:
- Release
summary: deleteReleaseById
description: Delete release
operationId: deleteReleaseById
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 release's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ReleasesResponse4'
- 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
/releases:
get:
tags:
- Release
summary: getRelease
description: List of release
operationId: getRelease
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/ReleasesResponse'
description: List of releases
example:
- release:
id: '10000'
number: '1000'
name: Release Name
description: description
state: New
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: Austin TX, USA
department:
id: '1'
name: Support
description: Support Department
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
approvers:
- group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
- release:
id: '10000'
number: '1000'
name: Release Name
description: description
state: New
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: Austin TX, USA
department:
id: '1'
name: Support
description: Support Department
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
approvers:
- group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/ReleasesResponse'
description: List of releases
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:
- Release
summary: createRelease
description: Create new release
operationId: createRelease
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Release fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ReleasesRequest1'
- description: Release fields to fill
example:
release:
name: Release Name
site_id: 1
department_id: 1
description: description
state: '1'
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01 00:00
planned_end_at: 2025-01-01 05:00
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
approval_levels_attributes:
- id: '1'
approver_ids: '1'
approval_condition: '1'
itsm_change_ids:
- 100
configuration_item_ids:
- 100
example:
release:
name: Release Name
site_id: 1
department_id: 1
description: description
state: '1'
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01 00:00
planned_end_at: 2025-01-01 05:00
assignee:
email: john.doe@email.com
requester:
email: john.doe@email.com
priority: High
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
custom_fields_values_attributes:
- id: 10
custom_field_id: 1
value: content
- id: 100
custom_field_id: 2
value: '1'
custom_fields_values:
custom_fields_value:
- name: Text custom field
value: content
- name: User custom field
user_value:
email: john.doe@email.com
approval_levels_attributes:
- id: '1'
approver_ids: '1'
approval_condition: '1'
itsm_change_ids:
- 100
configuration_item_ids:
- 100
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ReleasesResponse'
- example:
release:
id: '10000'
number: '1000'
name: Release Name
description: description
state: New
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: Austin TX, USA
department:
id: '1'
name: Support
description: Support Department
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
approvers:
- group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
release:
id: '10000'
number: '1000'
name: Release Name
description: description
state: New
plan: plan description
build: build description
deploy: deploy description
planned_start_at: 2025-01-01T00:00:00.000+01:00
planned_end_at: 2025-01-01T05:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: Austin TX, USA
department:
id: '1'
name: Support
description: Support Department
default_assignee_id: '1'
priority: High
created_by:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
assignee:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
requester:
id: '1'
account_id: '1'
user_id: '1'
email: john.doe@email.com
name: John Doe
disabled: false
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
tags:
- id: 1
name: tag1
taggings_count: 1
approvers:
- group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
changes:
- id: '100'
href: https://mydomain.com/changes/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ReleasesResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/solutions/{id}:
get:
tags:
- Solution
summary: getSolutionById
description: Get solution
operationId: getSolutionById
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/SolutionsResponse'
- example:
solution:
id: '10000'
number: '1000'
name: Solution Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
creator:
id: '1'
name: John Doe
email: john.doe@email.com
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
example:
solution:
id: '10000'
number: '1000'
name: Solution Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
creator:
id: '1'
name: John Doe
email: john.doe@email.com
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/SolutionsResponse'
- 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:
- Solution
summary: updateSolutionById
description: Update solution with specified fields
operationId: updateSolutionById
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: Solution fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SolutionsRequest'
- description: Solution fields to update
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
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
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SolutionsResponse'
- example:
solution:
id: '10000'
number: '1000'
name: Solution Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
creator:
id: '1'
name: John Doe
email: john.doe@email.com
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
example:
solution:
id: '10000'
number: '1000'
name: Solution Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
creator:
id: '1'
name: John Doe
email: john.doe@email.com
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/SolutionsResponse'
- 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:
- Solution
summary: deleteSolutionById
description: Delete solution
operationId: deleteSolutionById
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 solution's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SolutionsResponse4'
- 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
/solutions:
get:
tags:
- Solution
summary: getSolutions
description: List of solutions
operationId: getSolutions
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/SolutionsResponse'
description: List of solutions
example:
- solution:
id: '10000'
number: '1000'
name: Solution Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
creator:
id: '1'
name: John Doe
email: john.doe@email.com
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
example:
- solution:
id: '10000'
number: '1000'
name: Solution Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
creator:
id: '1'
name: John Doe
email: john.doe@email.com
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/SolutionsResponse'
description: List of solutions
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:
- Solution
summary: createSolution
description: Create new solution
operationId: createSolution
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: solution fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SolutionsRequest1'
- description: solution fields to fill
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
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
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SolutionsResponse'
- example:
solution:
id: '10000'
number: '1000'
name: Solution Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
creator:
id: '1'
name: John Doe
email: john.doe@email.com
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
example:
solution:
id: '10000'
number: '1000'
name: Solution Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
creator:
id: '1'
name: John Doe
email: john.doe@email.com
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/SolutionsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/catalog_items/{id}:
get:
tags:
- Catalog Item
summary: getCatalogItemById
description: Get catalog item
operationId: getCatalogItemById
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/CatalogItemsResponse'
- example:
catalog_item:
id: '10000'
number: '1000'
name: CI Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
category:
id: '10000'
name: Facilities
default_tags: tagA, tagB
parent_id: 'null'
default_assignee_id: '1'
subcategory:
id: '1000'
name: Equipment
default_tags: ''
parent_id: '10000'
default_assignee_id: '1'
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
tags:
- id: 1
name: tag1
taggings_count: 1
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
example:
catalog_item:
id: '10000'
number: '1000'
name: CI Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
category:
id: '10000'
name: Facilities
default_tags: tagA, tagB
parent_id: 'null'
default_assignee_id: '1'
subcategory:
id: '1000'
name: Equipment
default_tags: ''
parent_id: '10000'
default_assignee_id: '1'
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
tags:
- id: 1
name: tag1
taggings_count: 1
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsResponse'
- 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:
- Catalog Item
summary: updateCatalogItemById
description: Update catalog item with specified fields
operationId: updateCatalogItemById
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: Catalog item fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsRequest'
- description: Catalog item fields to update
example:
catalog_item:
name: CI Name
site_id: 1
department_id: 1
description: description
state: Approved
default_assignee_id: '1'
category:
name: Facilities
subcategory:
name: Equipment
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
example:
catalog_item:
name: CI Name
site_id: 1
department_id: 1
description: description
state: Approved
default_assignee_id: '1'
category:
name: Facilities
subcategory:
name: Equipment
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsResponse'
- example:
catalog_item:
id: '10000'
number: '1000'
name: CI Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
category:
id: '10000'
name: Facilities
default_tags: tagA, tagB
parent_id: 'null'
default_assignee_id: '1'
subcategory:
id: '1000'
name: Equipment
default_tags: ''
parent_id: '10000'
default_assignee_id: '1'
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
tags:
- id: 1
name: tag1
taggings_count: 1
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
example:
catalog_item:
id: '10000'
number: '1000'
name: CI Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
category:
id: '10000'
name: Facilities
default_tags: tagA, tagB
parent_id: 'null'
default_assignee_id: '1'
subcategory:
id: '1000'
name: Equipment
default_tags: ''
parent_id: '10000'
default_assignee_id: '1'
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
tags:
- id: 1
name: tag1
taggings_count: 1
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsResponse'
- 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:
- Catalog Item
summary: deleteCatalogItemById
description: Delete catalog item
operationId: deleteCatalogItemById
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 catalog item's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsResponse4'
- 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
/catalog_items:
get:
tags:
- Catalog Item
summary: getCatalogItems
description: List of catalog items
operationId: getCatalogItems
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/CatalogItemsResponse'
description: List of catalog items
example:
- catalog_item:
id: '10000'
number: '1000'
name: CI Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
category:
id: '10000'
name: Facilities
default_tags: tagA, tagB
parent_id: 'null'
default_assignee_id: '1'
subcategory:
id: '1000'
name: Equipment
default_tags: ''
parent_id: '10000'
default_assignee_id: '1'
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
tags:
- id: 1
name: tag1
taggings_count: 1
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
example:
- catalog_item:
id: '10000'
number: '1000'
name: CI Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
category:
id: '10000'
name: Facilities
default_tags: tagA, tagB
parent_id: 'null'
default_assignee_id: '1'
subcategory:
id: '1000'
name: Equipment
default_tags: ''
parent_id: '10000'
default_assignee_id: '1'
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
tags:
- id: 1
name: tag1
taggings_count: 1
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CatalogItemsResponse'
description: List of catalog items
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:
- Catalog Item
summary: createCatalogItem
description: Create new catalog item
operationId: createCatalogItem
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Catalog Item fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsRequest1'
- description: Catalog Item fields to fill
example:
catalog_item:
name: CI Name
site_id: 1
department_id: 1
description: description
state: Approved
default_assignee_id: '1'
category:
name: Facilities
subcategory:
name: Equipment
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
example:
catalog_item:
name: CI Name
site_id: 1
department_id: 1
description: description
state: Approved
default_assignee_id: '1'
category:
name: Facilities
subcategory:
name: Equipment
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
add_to_tag_list: tag1
remove_from_tag_list: tag2
tag_list: tag1
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsResponse'
- example:
catalog_item:
id: '10000'
number: '1000'
name: CI Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
category:
id: '10000'
name: Facilities
default_tags: tagA, tagB
parent_id: 'null'
default_assignee_id: '1'
subcategory:
id: '1000'
name: Equipment
default_tags: ''
parent_id: '10000'
default_assignee_id: '1'
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
tags:
- id: 1
name: tag1
taggings_count: 1
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
example:
catalog_item:
id: '10000'
number: '1000'
name: CI Name
description: description
created_at: 2025-01-01T00:00:00.000+01:00
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
category:
id: '10000'
name: Facilities
default_tags: tagA, tagB
parent_id: 'null'
default_assignee_id: '1'
subcategory:
id: '1000'
name: Equipment
default_tags: ''
parent_id: '10000'
default_assignee_id: '1'
expected_delivery_time: 1 day
currency: USD
price: '1'
show_price: true
tags:
- id: 1
name: tag1
taggings_count: 1
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/catalog_items/{id}/service_requests:
post:
tags:
- Service Request
summary: createServiceRequest
description: Request a Service
operationId: createServiceRequest
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: Service Request fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsServiceRequestsRequest'
- description: Service Request fields to fill
example:
incident:
site_id: '1'
department_id: '1'
requester_name: john.doe@email.com
priority: High
due_at: Jan 01,2025
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
request_variables_attributes:
- name: Variable name
value: Content
- name: User Variable
user_value:
email: john.doe@email.com
- name: MultyPickList variable
value: option1#dlmtr#option2
example:
incident:
site_id: '1'
department_id: '1'
requester_name: john.doe@email.com
priority: High
due_at: Jan 01,2025
add_to_tag_list: tag1, tag2
remove_from_tag_list: tag3
tag_list: tag1, tag2
request_variables_attributes:
- name: Variable name
value: Content
- name: User Variable
user_value:
email: john.doe@email.com
- name: MultyPickList variable
value: option1#dlmtr#option2
required: false
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CatalogItemsServiceRequestsResponse'
- 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/CatalogItemsServiceRequestsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/configuration_items/{id}:
get:
tags:
- Configuration Item
summary: getConfigurationItemById
description: Get configuration item
operationId: getConfigurationItemById
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/ConfigurationItemsResponse'
- example:
configuration_item:
id: '10000'
number: '1000'
name: Configuration Item Name
description: description
asset_tag: ConfigurationItemTag
type:
id: 1
name: Building
description: Configuration Item - Building
parent_id: 1
custom: false
updated_at: 2025-01-01T00:00:00.000+01:00
icon_name: BUILDING
type_id: 1
state: Active
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
manager_id:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
user_id:
group_id: '1'
is_user: 'true'
id: '1'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '1000'
custom_field_id: '1'
name: field name
value: content
options: ''
type_name: Text
updated_at: 2025-01-01T00:00:00.000+01:00
created_at: 2025-01-01T00:00:00.000+01:00
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
purchase_orders:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
configuration_item:
id: '10000'
number: '1000'
name: Configuration Item Name
description: description
asset_tag: ConfigurationItemTag
type:
id: 1
name: Building
description: Configuration Item - Building
parent_id: 1
custom: false
updated_at: 2025-01-01T00:00:00.000+01:00
icon_name: BUILDING
type_id: 1
state: Active
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
manager_id:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
user_id:
group_id: '1'
is_user: 'true'
id: '1'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '1000'
custom_field_id: '1'
name: field name
value: content
options: ''
type_name: Text
updated_at: 2025-01-01T00:00:00.000+01:00
created_at: 2025-01-01T00:00:00.000+01:00
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
purchase_orders:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ConfigurationItemsResponse'
- 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:
- Configuration Item
summary: updateConfigurationItemById
description: Update configuration item with specified fields
operationId: updateConfigurationItemById
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: Configuration Item fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ConfigurationItemsRequest'
- description: Configuration Item fields to update
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
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
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ConfigurationItemsResponse'
- example:
configuration_item:
id: '10000'
number: '1000'
name: Configuration Item Name
description: description
asset_tag: ConfigurationItemTag
type:
id: 1
name: Building
description: Configuration Item - Building
parent_id: 1
custom: false
updated_at: 2025-01-01T00:00:00.000+01:00
icon_name: BUILDING
type_id: 1
state: Active
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
manager_id:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
user_id:
group_id: '1'
is_user: 'true'
id: '1'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '1000'
custom_field_id: '1'
name: field name
value: content
options: ''
type_name: Text
updated_at: 2025-01-01T00:00:00.000+01:00
created_at: 2025-01-01T00:00:00.000+01:00
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
purchase_orders:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
configuration_item:
id: '10000'
number: '1000'
name: Configuration Item Name
description: description
asset_tag: ConfigurationItemTag
type:
id: 1
name: Building
description: Configuration Item - Building
parent_id: 1
custom: false
updated_at: 2025-01-01T00:00:00.000+01:00
icon_name: BUILDING
type_id: 1
state: Active
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
manager_id:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
user_id:
group_id: '1'
is_user: 'true'
id: '1'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '1000'
custom_field_id: '1'
name: field name
value: content
options: ''
type_name: Text
updated_at: 2025-01-01T00:00:00.000+01:00
created_at: 2025-01-01T00:00:00.000+01:00
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
purchase_orders:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ConfigurationItemsResponse'
- 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:
- Configuration Item
summary: deleteConfigurationItemById
description: Delete configurationitem
operationId: deleteConfigurationItemById
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 configuration item's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ConfigurationItemsResponse4'
- 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
/configuration_items:
get:
tags:
- Configuration Item
summary: getConfigurationItems
description: List of configuration items
operationId: getConfigurationItems
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/ConfigurationItemsResponse'
description: List of configuration items
example:
- configuration_item:
id: '10000'
number: '1000'
name: Configuration Item Name
description: description
asset_tag: ConfigurationItemTag
type:
id: 1
name: Building
description: Configuration Item - Building
parent_id: 1
custom: false
updated_at: 2025-01-01T00:00:00.000+01:00
icon_name: BUILDING
type_id: 1
state: Active
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
manager_id:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
user_id:
group_id: '1'
is_user: 'true'
id: '1'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '1000'
custom_field_id: '1'
name: field name
value: content
options: ''
type_name: Text
updated_at: 2025-01-01T00:00:00.000+01:00
created_at: 2025-01-01T00:00:00.000+01:00
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
purchase_orders:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
- configuration_item:
id: '10000'
number: '1000'
name: Configuration Item Name
description: description
asset_tag: ConfigurationItemTag
type:
id: 1
name: Building
description: Configuration Item - Building
parent_id: 1
custom: false
updated_at: 2025-01-01T00:00:00.000+01:00
icon_name: BUILDING
type_id: 1
state: Active
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
manager_id:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
user_id:
group_id: '1'
is_user: 'true'
id: '1'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '1000'
custom_field_id: '1'
name: field name
value: content
options: ''
type_name: Text
updated_at: 2025-01-01T00:00:00.000+01:00
created_at: 2025-01-01T00:00:00.000+01:00
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
purchase_orders:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigurationItemsResponse'
description: List of configuration items
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:
- Configuration Item
summary: createConfigurationItem
description: Create new configurationitem
operationId: createConfigurationItem
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Configuration Item fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ConfigurationItemsRequest1'
- description: Configuration Item fields to fill
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
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
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ConfigurationItemsResponse'
- example:
configuration_item:
id: '10000'
number: '1000'
name: Configuration Item Name
description: description
asset_tag: ConfigurationItemTag
type:
id: 1
name: Building
description: Configuration Item - Building
parent_id: 1
custom: false
updated_at: 2025-01-01T00:00:00.000+01:00
icon_name: BUILDING
type_id: 1
state: Active
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
manager_id:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
user_id:
group_id: '1'
is_user: 'true'
id: '1'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '1000'
custom_field_id: '1'
name: field name
value: content
options: ''
type_name: Text
updated_at: 2025-01-01T00:00:00.000+01:00
created_at: 2025-01-01T00:00:00.000+01:00
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
purchase_orders:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
example:
configuration_item:
id: '10000'
number: '1000'
name: Configuration Item Name
description: description
asset_tag: ConfigurationItemTag
type:
id: 1
name: Building
description: Configuration Item - Building
parent_id: 1
custom: false
updated_at: 2025-01-01T00:00:00.000+01:00
icon_name: BUILDING
type_id: 1
state: Active
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
manager_id:
group_id: '1'
is_user: 'true'
id: '1'
name: John Doe
email: john.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
user_id:
group_id: '1'
is_user: 'true'
id: '1'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4165'
initials: JD
custom_fields_values:
- id: '1000'
custom_field_id: '1'
name: field name
value: content
options: ''
type_name: Text
updated_at: 2025-01-01T00:00:00.000+01:00
created_at: 2025-01-01T00:00:00.000+01:00
origin: api
incidents:
- id: '100'
href: https://mydomain.com/incidents/100
problems:
- id: '100'
href: https://mydomain.com/problems/100
changes:
- id: '100'
href: https://mydomain.com/changes/100
releases:
- id: '100'
href: https://mydomain.com/releases/100
purchase_orders:
- id: '100'
href: https://mydomain.com/releases/100
configuration_items:
- id: '100'
href: https://mydomain.com/configuration_items/100
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ConfigurationItemsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/configuration_items/{id}/append_multiple_dependent_assets:
put:
tags:
- Configuration Item
summary: appendDependentAssets
description: Append multiple dependent assets
operationId: appendDependentAssets
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: Dependencies fields to fill
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/ConfigurationItemsAppendMultipleDependentAssetsRequest'
description: Dependencies fields to fill
xml:
name: _
attribute: false
wrapped: false
required: false
responses:
'200':
description: Dependency added successfully
headers: {}
content: {}
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/asset_links/delete_asset_link_by_id:
put:
tags:
- Configuration Item
summary: deleteAssetLink
description: Delete dpendency by id
operationId: deleteAssetLink
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Dependencies fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AssetLinksDeleteAssetLinkByIdRequest'
- description: Dependencies fields to fill
required: false
responses:
'200':
description: Dependency removed successfully
headers: {}
content: {}
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/users/{id}:
get:
tags:
- User
summary: getUserById
description: Get user
operationId: getUserById
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/UsersResponse'
- example:
user:
id: '10000'
name: John Doe
title: Support Agent
disabled: false
email: john.doe@email.com
created_at: 2030-01-01T00:00:00.000+00:00
phone: '+10000000'
mobile_phone: '+10000000'
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
role:
id: 1
name: Requester
description: Requester role.
portal: true
show_my_tasks: true
group_ids:
- 1
avatar:
type: initials
color: '#fd4165'
initials: JD
reports_to:
group_id: '1'
is_user: 'true'
id: '100'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4166'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
example:
user:
id: '10000'
name: John Doe
title: Support Agent
disabled: false
email: john.doe@email.com
created_at: 2030-01-01T00:00:00.000+00:00
phone: '+10000000'
mobile_phone: '+10000000'
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
role:
id: 1
name: Requester
description: Requester role.
portal: true
show_my_tasks: true
group_ids:
- 1
avatar:
type: initials
color: '#fd4165'
initials: JD
reports_to:
group_id: '1'
is_user: 'true'
id: '100'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4166'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/UsersResponse'
- 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:
- User
summary: updateUserById
description: Update user with specified fields
operationId: updateUserById
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: User fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UsersRequest'
- description: User fields to update
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
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
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UsersResponse'
- example:
user:
id: '10000'
name: John Doe
title: Support Agent
disabled: false
email: john.doe@email.com
created_at: 2030-01-01T00:00:00.000+00:00
phone: '+10000000'
mobile_phone: '+10000000'
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
role:
id: 1
name: Requester
description: Requester role.
portal: true
show_my_tasks: true
group_ids:
- 1
avatar:
type: initials
color: '#fd4165'
initials: JD
reports_to:
group_id: '1'
is_user: 'true'
id: '100'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4166'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
example:
user:
id: '10000'
name: John Doe
title: Support Agent
disabled: false
email: john.doe@email.com
created_at: 2030-01-01T00:00:00.000+00:00
phone: '+10000000'
mobile_phone: '+10000000'
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
role:
id: 1
name: Requester
description: Requester role.
portal: true
show_my_tasks: true
group_ids:
- 1
avatar:
type: initials
color: '#fd4165'
initials: JD
reports_to:
group_id: '1'
is_user: 'true'
id: '100'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4166'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/UsersResponse'
- 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:
- User
summary: deleteUserById
description: Delete user
operationId: deleteUserById
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: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UsersResponse4'
- example:
messages:
message: Deleted user
example:
messages:
message: Deleted user
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/users:
get:
tags:
- User
summary: getUsers
description: List of Users
operationId: getUsers
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/UsersResponse'
description: List of users
example:
- user:
id: '10000'
name: John Doe
title: Support Agent
disabled: false
email: john.doe@email.com
created_at: 2030-01-01T00:00:00.000+00:00
phone: '+10000000'
mobile_phone: '+10000000'
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
role:
id: 1
name: Requester
description: Requester role.
portal: true
show_my_tasks: true
group_ids:
- 1
avatar:
type: initials
color: '#fd4165'
initials: JD
reports_to:
group_id: '1'
is_user: 'true'
id: '100'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4166'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
example:
- user:
id: '10000'
name: John Doe
title: Support Agent
disabled: false
email: john.doe@email.com
created_at: 2030-01-01T00:00:00.000+00:00
phone: '+10000000'
mobile_phone: '+10000000'
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
role:
id: 1
name: Requester
description: Requester role.
portal: true
show_my_tasks: true
group_ids:
- 1
avatar:
type: initials
color: '#fd4165'
initials: JD
reports_to:
group_id: '1'
is_user: 'true'
id: '100'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4166'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/UsersResponse'
description: List of users
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:
- User
summary: createUser
description: Create new user
operationId: createUser
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: User fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UsersRequest1'
- description: User fields to fill
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
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
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UsersResponse'
- example:
user:
id: '10000'
name: John Doe
title: Support Agent
disabled: false
email: john.doe@email.com
created_at: 2030-01-01T00:00:00.000+00:00
phone: '+10000000'
mobile_phone: '+10000000'
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
role:
id: 1
name: Requester
description: Requester role.
portal: true
show_my_tasks: true
group_ids:
- 1
avatar:
type: initials
color: '#fd4165'
initials: JD
reports_to:
group_id: '1'
is_user: 'true'
id: '100'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4166'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
example:
user:
id: '10000'
name: John Doe
title: Support Agent
disabled: false
email: john.doe@email.com
created_at: 2030-01-01T00:00:00.000+00:00
phone: '+10000000'
mobile_phone: '+10000000'
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
role:
id: 1
name: Requester
description: Requester role.
portal: true
show_my_tasks: true
group_ids:
- 1
avatar:
type: initials
color: '#fd4165'
initials: JD
reports_to:
group_id: '1'
is_user: 'true'
id: '100'
name: Jane Doe
email: jane.doe@email.com
avatar:
type: initials
color: '#fd4166'
initials: JD
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/UsersResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/sites/{id}:
get:
tags:
- Site
summary: getSiteById
description: Get site
operationId: getSiteById
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:
$ref: '#/components/schemas/SitesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/SitesResponse'
- 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:
- Site
summary: updateSiteById
description: Update site with specified fields
operationId: updateSiteById
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: Site fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SitesRequest'
- description: Site fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SitesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/SitesResponse'
- 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:
- Site
summary: deleteSiteById
description: Delete site
operationId: deleteSiteById
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: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SitesResponse4'
- example:
messages:
message: Deleted site
example:
messages:
message: Deleted site
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/sites:
get:
tags:
- Site
summary: getSites
description: List of Sites
operationId: getSites
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/SitesResponse'
description: List of sites
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/SitesResponse'
description: List of sites
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:
- Site
summary: createSite
description: Create new site
operationId: createSite
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Site fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SitesRequest1'
- description: Site fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SitesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/SitesResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/departments/{id}:
get:
tags:
- Department
summary: getDepartmentById
description: Get department
operationId: getDepartmentById
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:
$ref: '#/components/schemas/DepartmentsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/DepartmentsResponse'
- 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:
- Department
summary: updateDepartmentById
description: Update department with specified fields
operationId: updateDepartmentById
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: Department fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DepartmentsRequest'
- description: Department fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DepartmentsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/DepartmentsResponse'
- 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:
- Department
summary: deleteDepartmentById
description: Delete department
operationId: deleteDepartmentById
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: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DepartmentsResponse4'
- example:
messages:
message: Deleted department
example:
messages:
message: Deleted department
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/departments:
get:
tags:
- Department
summary: getDepartments
description: List of Departments
operationId: getDepartments
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/DepartmentsResponse'
description: List of departments
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/DepartmentsResponse'
description: List of departments
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:
- Department
summary: createDepartment
description: Create new department
operationId: createDepartment
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Department fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DepartmentsRequest1'
- description: Department fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DepartmentsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/DepartmentsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/roles/{id}:
get:
tags:
- Role
summary: getRoleById
description: Get role
operationId: getRoleById
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:
$ref: '#/components/schemas/RolesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/RolesResponse'
- 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:
- Role
summary: updateRoleById
description: Update role with specified fields
operationId: updateRoleById
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: Role fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RolesRequest'
- description: Role fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RolesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/RolesResponse'
- 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:
- Role
summary: deleteRoleById
description: Delete role
operationId: deleteRoleById
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: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RolesResponse4'
- example:
messages:
message: Deleted role
example:
messages:
message: Deleted role
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/roles:
get:
tags:
- Role
summary: getRoles
description: List of roles
operationId: getRoles
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/RolesResponse'
description: List of roles
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/RolesResponse'
description: List of role
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:
- Role
summary: createRole
description: Create new role
operationId: createRole
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Role fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RolesRequest1'
- description: Role fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RolesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/RolesResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/groups/{id}:
get:
tags:
- Group
summary: getGroupById
description: Get group
operationId: getGroupById
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:
$ref: '#/components/schemas/GroupsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/GroupsResponse'
- 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:
- Group
summary: updateGroupById
description: Update group with specified fields
operationId: updateGroupById
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: Group fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GroupsRequest'
- description: Group fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GroupsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/GroupsResponse'
- 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:
- Group
summary: deleteGroupById
description: Delete group
operationId: deleteGroupById
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: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GroupsResponse4'
- example:
messages:
message: Deleted group
example:
messages:
message: Deleted group
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/groups:
get:
tags:
- Group
summary: getGroups
description: List of groups
operationId: getGroups
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/GroupsResponse'
description: List of groups
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/GroupsResponse'
description: List of groups
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:
- Group
summary: createGroup
description: Create new group
operationId: createGroup
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Group fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GroupsRequest1'
- description: Group fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GroupsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/GroupsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/memberships:
post:
tags:
- Membership
summary: createMembership
description: >-
Create new Membership. Memberships are used to relate a user to a group.
Example: 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
operationId: createMembership
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
- name: group_id
in: query
description: Numeric ID of the group
required: true
style: form
explode: true
schema:
type: string
- name: user_ids
in: query
description: Numeric IDs of the users
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: membership created and returned correctly
headers: {}
content: {}
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/memberships/{id}:
delete:
tags:
- Membership
summary: deleteMemebershipById
description: >-
Delete membership.
Example: 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
operationId: deleteMemebershipById
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: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MembershipsResponse'
- example:
messages:
message: Deleted membership
example:
messages:
message: Deleted membership
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/categories/{id}:
get:
tags:
- Category
summary: getCategoryById
description: Get category
operationId: getCategoryById
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:
$ref: '#/components/schemas/CategoriesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/CategoriesResponse'
- 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:
- Category
summary: updateCategoryById
description: Update category with specified fields
operationId: updateCategoryById
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: Category fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CategoriesRequest'
- description: Category fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CategoriesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/CategoriesResponse'
- 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:
- Category
summary: deleteCategoryById
description: Delete category
operationId: deleteCategoryById
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: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CategoriesResponse4'
- example:
messages:
message: Deleted category
example:
messages:
message: Deleted category
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/categories:
get:
tags:
- Category
summary: getCategories
description: List of categories
operationId: getCategories
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/CategoriesResponse'
description: List of categories
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/CategoriesResponse'
description: List of categories
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:
- Category
summary: createCategory
description: Create new category
operationId: createCategory
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Category fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CategoriesRequest1'
- description: Category fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CategoriesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/CategoriesResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/hardwares/{id}:
get:
tags:
- Hardware
summary: getHardwareById
description: Get hardware
operationId: getHardwareById
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/HardwaresResponse'
- example:
hardware:
id: 1
name: Hardware Name
description: description
category:
id: 1
name: Laptop
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
ip: 0.0.0.0
external_ip: 0.0.0.0
status: '{"name":"Operational"}'
technical_contact:
email: john.doe@email.com
owner:
email: john.doe@email.com
notes: Hardware notes
barcode_encoding_format: Code1A
cpu: hardware_cpu
processor_speed: processor_speed
memory: '1024'
swap: MB
operating_system: Windows 10
domain: domain description
active_directory: Workgroup of the OS
address: Site 1, Building 1, Department 1
longitude: '0.000'
latitude: '0.000'
product_number: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
bioses:
- id: 1
manufacturer: Dell
ssn: '1'
model: model description
version: '1'
bios_date: 2020-01-01 00:00
reported_at: 2020-01-01 00:00
tag: tag
asset_tag: '1'
example:
hardware:
id: 1
name: Hardware Name
description: description
category:
id: 1
name: Laptop
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
ip: 0.0.0.0
external_ip: 0.0.0.0
status: '{"name":"Operational"}'
technical_contact:
email: john.doe@email.com
owner:
email: john.doe@email.com
notes: Hardware notes
barcode_encoding_format: Code1A
cpu: hardware_cpu
processor_speed: processor_speed
memory: '1024'
swap: MB
operating_system: Windows 10
domain: domain description
active_directory: Workgroup of the OS
address: Site 1, Building 1, Department 1
longitude: '0.000'
latitude: '0.000'
product_number: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
bioses:
- id: 1
manufacturer: Dell
ssn: '1'
model: model description
version: '1'
bios_date: 2020-01-01 00:00
reported_at: 2020-01-01 00:00
tag: tag
asset_tag: '1'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresResponse'
- 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:
- Hardware
summary: updateHardwareById
description: Update hardware with specified fields
operationId: updateHardwareById
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: Hardware fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresRequest'
- description: Hardware fields to update
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
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
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresResponse'
- example:
hardware:
id: 1
name: Hardware Name
description: description
category:
id: 1
name: Laptop
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
ip: 0.0.0.0
external_ip: 0.0.0.0
status: '{"name":"Operational"}'
technical_contact:
email: john.doe@email.com
owner:
email: john.doe@email.com
notes: Hardware notes
barcode_encoding_format: Code1A
cpu: hardware_cpu
processor_speed: processor_speed
memory: '1024'
swap: MB
operating_system: Windows 10
domain: domain description
active_directory: Workgroup of the OS
address: Site 1, Building 1, Department 1
longitude: '0.000'
latitude: '0.000'
product_number: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
bioses:
- id: 1
manufacturer: Dell
ssn: '1'
model: model description
version: '1'
bios_date: 2020-01-01 00:00
reported_at: 2020-01-01 00:00
tag: tag
asset_tag: '1'
example:
hardware:
id: 1
name: Hardware Name
description: description
category:
id: 1
name: Laptop
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
ip: 0.0.0.0
external_ip: 0.0.0.0
status: '{"name":"Operational"}'
technical_contact:
email: john.doe@email.com
owner:
email: john.doe@email.com
notes: Hardware notes
barcode_encoding_format: Code1A
cpu: hardware_cpu
processor_speed: processor_speed
memory: '1024'
swap: MB
operating_system: Windows 10
domain: domain description
active_directory: Workgroup of the OS
address: Site 1, Building 1, Department 1
longitude: '0.000'
latitude: '0.000'
product_number: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
bioses:
- id: 1
manufacturer: Dell
ssn: '1'
model: model description
version: '1'
bios_date: 2020-01-01 00:00
reported_at: 2020-01-01 00:00
tag: tag
asset_tag: '1'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresResponse'
- 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:
- Hardware
summary: deleteHardwareById
description: Delete hardware
operationId: deleteHardwareById
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 hardware's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresResponse4'
- 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
/hardwares:
get:
tags:
- Hardware
summary: getHardwares
description: List of hardwares
operationId: getHardwares
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/HardwaresResponse'
description: List of hardwares
example:
- hardware:
id: 1
name: Hardware Name
description: description
category:
id: 1
name: Laptop
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
ip: 0.0.0.0
external_ip: 0.0.0.0
status: '{"name":"Operational"}'
technical_contact:
email: john.doe@email.com
owner:
email: john.doe@email.com
notes: Hardware notes
barcode_encoding_format: Code1A
cpu: hardware_cpu
processor_speed: processor_speed
memory: '1024'
swap: MB
operating_system: Windows 10
domain: domain description
active_directory: Workgroup of the OS
address: Site 1, Building 1, Department 1
longitude: '0.000'
latitude: '0.000'
product_number: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
bioses:
- id: 1
manufacturer: Dell
ssn: '1'
model: model description
version: '1'
bios_date: 2020-01-01 00:00
reported_at: 2020-01-01 00:00
tag: tag
asset_tag: '1'
example:
- hardware:
id: 1
name: Hardware Name
description: description
category:
id: 1
name: Laptop
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
ip: 0.0.0.0
external_ip: 0.0.0.0
status: '{"name":"Operational"}'
technical_contact:
email: john.doe@email.com
owner:
email: john.doe@email.com
notes: Hardware notes
barcode_encoding_format: Code1A
cpu: hardware_cpu
processor_speed: processor_speed
memory: '1024'
swap: MB
operating_system: Windows 10
domain: domain description
active_directory: Workgroup of the OS
address: Site 1, Building 1, Department 1
longitude: '0.000'
latitude: '0.000'
product_number: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
bioses:
- id: 1
manufacturer: Dell
ssn: '1'
model: model description
version: '1'
bios_date: 2020-01-01 00:00
reported_at: 2020-01-01 00:00
tag: tag
asset_tag: '1'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/HardwaresResponse'
description: List of hardwares
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:
- Hardware
summary: createHardware
description: Create new hardware
operationId: createHardware
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Hardware fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresRequest1'
- description: Hardware fields to fill
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
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
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresResponse'
- example:
hardware:
id: 1
name: Hardware Name
description: description
category:
id: 1
name: Laptop
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
ip: 0.0.0.0
external_ip: 0.0.0.0
status: '{"name":"Operational"}'
technical_contact:
email: john.doe@email.com
owner:
email: john.doe@email.com
notes: Hardware notes
barcode_encoding_format: Code1A
cpu: hardware_cpu
processor_speed: processor_speed
memory: '1024'
swap: MB
operating_system: Windows 10
domain: domain description
active_directory: Workgroup of the OS
address: Site 1, Building 1, Department 1
longitude: '0.000'
latitude: '0.000'
product_number: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
bioses:
- id: 1
manufacturer: Dell
ssn: '1'
model: model description
version: '1'
bios_date: 2020-01-01 00:00
reported_at: 2020-01-01 00:00
tag: tag
asset_tag: '1'
example:
hardware:
id: 1
name: Hardware Name
description: description
category:
id: 1
name: Laptop
site:
id: '1'
name: Austin TX, USA
location: AUS
description: ''
time_zone: ''
department:
id: '1'
name: Support
description: ''
default_assignee_id: '1'
ip: 0.0.0.0
external_ip: 0.0.0.0
status: '{"name":"Operational"}'
technical_contact:
email: john.doe@email.com
owner:
email: john.doe@email.com
notes: Hardware notes
barcode_encoding_format: Code1A
cpu: hardware_cpu
processor_speed: processor_speed
memory: '1024'
swap: MB
operating_system: Windows 10
domain: domain description
active_directory: Workgroup of the OS
address: Site 1, Building 1, Department 1
longitude: '0.000'
latitude: '0.000'
product_number: 1
custom_fields_values:
- id: '10'
custom_field_id: '1'
name: Text custom field
value: content
options: ''
type_name: Text
- id: '100'
custom_field_id: '2'
name: User custom field
value: '1'
options: ''
type_name: User
user:
group_id: 1
is_user: true
id: 1
name: John Doe
email: john.doe@email.com
bioses:
- id: 1
manufacturer: Dell
ssn: '1'
model: model description
version: '1'
bios_date: 2020-01-01 00:00
reported_at: 2020-01-01 00:00
tag: tag
asset_tag: '1'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/hardwares/{id}/warranties:
get:
tags:
- Hardware
summary: getWarranties
description: List of warranties
operationId: getWarranties
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:
type: array
items:
$ref: '#/components/schemas/HardwaresWarrantiesResponse'
description: List of warranties
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/HardwaresWarrantiesResponse'
description: List of warranties
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:
- Hardware
summary: createWarranty
description: Create new Warranty
operationId: createWarranty
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: Warranty fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresWarrantiesRequest'
- description: Warranty fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/HardwaresWarrantiesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresWarrantiesResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/hardwares/{hardware_id}/warranties/{warranty_id}:
put:
tags:
- Hardware
summary: updateWarrantyById
description: Update warranty with specified fields
operationId: updateWarrantyById
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
- name: hardware_id
in: path
description: Numeric ID of the hardware
required: true
style: simple
schema:
type: string
- name: warranty_id
in: path
description: Numeric ID of the warranty
required: true
style: simple
schema:
type: string
requestBody:
description: Warranty fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresWarrantiesRequest'
- description: Warranty fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/HardwaresWarrantiesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresWarrantiesResponse'
- 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:
- Hardware
summary: deleteWarrantyById
description: Delete warranty
operationId: deleteWarrantyById
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
- name: hardware_id
in: path
description: Numeric ID of the hardware
required: true
style: simple
schema:
type: string
- name: warranty_id
in: path
description: Numeric ID of the warranty
required: true
style: simple
schema:
type: string
responses:
'200':
description: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/HardwaresWarrantiesResponse6'
- example:
messages:
message: Deleted warranty
example:
messages:
message: Deleted warranty
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/mobiles/{id}:
get:
tags:
- Mobile Device
summary: getMobileById
description: Get mobile device
operationId: getMobileById
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:
$ref: '#/components/schemas/MobilesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/MobilesResponse'
- 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:
- Mobile Device
summary: updateMobileById
description: Update mobile device with specified fields
operationId: updateMobileById
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: Mobile device fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MobilesRequest'
- description: Mobile device fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MobilesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/MobilesResponse'
- 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:
- Mobile Device
summary: deleteMobileById
description: Delete mobile device
operationId: deleteMobileById
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 mobile's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MobilesResponse4'
- 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
/mobiles:
get:
tags:
- Mobile Device
summary: getMobiles
description: List of mobile devices
operationId: getMobiles
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/MobilesResponse'
description: List of mobile devices
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/MobilesResponse'
description: List of mobile devices
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:
- Mobile Device
summary: createMobile
description: Create new mobile device
operationId: createMobile
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Mobile Device fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MobilesRequest1'
- description: Mobile Device fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MobilesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/MobilesResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/other_assets/{id}:
get:
tags:
- Other Asset
summary: getAssetById
description: Get other asset
operationId: getAssetById
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:
$ref: '#/components/schemas/OtherAssetsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/OtherAssetsResponse'
- 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:
- Other Asset
summary: updateAssetById
description: Update other asset with specified fields
operationId: updateAssetById
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: Other asset fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/OtherAssetsRequest'
- description: Other asset fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OtherAssetsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/OtherAssetsResponse'
- 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:
- Other Asset
summary: deleteAssetById
description: Delete other asset
operationId: deleteAssetById
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 other_asset's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/OtherAssetsResponse4'
- 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
/other_assets:
get:
tags:
- Other Asset
summary: getAssets
description: List of other assets
operationId: getAssets
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/OtherAssetsResponse'
description: List of other assets
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/OtherAssetsResponse'
description: List of other asset
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:
- Other Asset
summary: createAsset
description: Create new asset
operationId: createAsset
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Other Asset fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/OtherAssetsRequest1'
- description: Other Asset fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OtherAssetsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/OtherAssetsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/softwares/{id}:
get:
tags:
- Software
summary: getSoftwareById
description: Get software
operationId: getSoftwareById
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:
$ref: '#/components/schemas/SoftwaresResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/SoftwaresResponse'
- 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
/softwares:
get:
tags:
- Software
summary: getSoftwares
description: List of softwares
operationId: getSoftwares
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/SoftwaresResponse'
description: List of softwares
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/SoftwaresResponse'
description: List of softwares
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
/printers/{id}:
get:
tags:
- Printer
summary: getPrinterById
description: Get printer
operationId: getPrinterById
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:
$ref: '#/components/schemas/PrintersResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/PrintersResponse'
- 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:
- Printer
summary: updatePrinterById
description: Update printer with specified fields
operationId: updatePrinterById
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: Printer fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PrintersRequest'
- description: Printer fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PrintersResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/PrintersResponse'
- 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
/printers:
get:
tags:
- Printer
summary: getPrinters
description: List of printers
operationId: getPrinters
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/PrintersResponse'
description: List of printers
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/PrintersResponse'
description: List of printers
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
/contracts/{id}:
get:
tags:
- Contract
summary: getContractById
description: Get contract
operationId: getContractById
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:
$ref: '#/components/schemas/ContractsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ContractsResponse'
- 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:
- Contract
summary: updateContractById
description: Update contract with specified fields
operationId: updateContractById
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: Contract fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ContractsRequest'
- description: Contract fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ContractsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ContractsResponse'
- 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:
- Contract
summary: deleteContractById
description: Delete contract
operationId: deleteContractById
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 contract's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ContractsResponse4'
- 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
/contracts:
get:
tags:
- Contract
summary: getContracts
description: List of contracts
operationId: getContracts
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/ContractsResponse'
description: List of contracts
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/ContractsResponse'
description: List of contracts
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:
- Contract
summary: createContract
description: Create new contract
operationId: createContract
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Contract fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ContractsRequest1'
- description: Contract fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ContractsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ContractsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/contracts/{id}/items:
post:
tags:
- Contract
summary: createItem
description: Create new contract's Item
operationId: createItem
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: Item fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ContractsItemsRequest'
- description: Item fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ContractsItemsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ContractsItemsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/contracts/{contract_id}/items/{item_id}:
put:
tags:
- Contract
summary: updateItemById
description: Update contract's item with specified fields
operationId: updateItemById
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
- name: contract_id
in: path
description: Numeric ID of the contract
required: true
style: simple
schema:
type: string
- name: item_id
in: path
description: Numeric ID of the item
required: true
style: simple
schema:
type: string
requestBody:
description: Contract's Item fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ContractsItemsRequest1'
- description: Contract's Item fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ContractsItemsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ContractsItemsResponse'
- 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:
- Contract
summary: deleteitemById
description: Delete contract's item
operationId: deleteitemById
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
- name: contract_id
in: path
description: Numeric ID of the contract
required: true
style: simple
schema:
type: string
- name: item_id
in: path
description: Numeric ID of the item
required: true
style: simple
schema:
type: string
responses:
'200':
description: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ContractsItemsResponse4'
- example:
messages:
message: Deleted item
example:
messages:
message: Deleted item
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/purchase_orders/{id}:
get:
tags:
- Purchase Order
summary: getPurchaseOrderById
description: Get purchase order
operationId: getPurchaseOrderById
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:
$ref: '#/components/schemas/PurchaseOrdersResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/PurchaseOrdersResponse'
- 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:
- Purchase Order
summary: updatePurchaseOrderById
description: Update purchase order with specified fields
operationId: updatePurchaseOrderById
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: Purchase Order fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PurchaseOrdersRequest'
- description: Purchase Order fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrdersResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/PurchaseOrdersResponse'
- 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:
- Purchase Order
summary: deletePurchaseOrderById
description: Delete purchase order
operationId: deletePurchaseOrderById
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 purchase order's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PurchaseOrdersResponse4'
- 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
/purchase_orders:
get:
tags:
- Purchase Order
summary: getCPurchaseOrders
description: List of purchase orders
operationId: getCPurchaseOrders
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/PurchaseOrdersResponse'
description: List of purchase orders
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/PurchaseOrdersResponse'
description: List of purchase orders
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:
- Purchase Order
summary: createPurchaseOrder
description: Create new purchase order
operationId: createPurchaseOrder
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Purchase order fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PurchaseOrdersRequest1'
- description: Purchase order fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrdersResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/PurchaseOrdersResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/vendors/{id}:
get:
tags:
- Vendor
summary: getVendorById
description: Get vendor
operationId: getVendorById
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:
$ref: '#/components/schemas/VendorsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/VendorsResponse'
- 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:
- Vendor
summary: updateVendorById
description: Update vendor with specified fields
operationId: updateVendorById
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: Vendor fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/VendorsRequest'
- description: Vendor fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VendorsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/VendorsResponse'
- 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:
- Vendor
summary: deleteVendorById
description: Delete vendor
operationId: deleteVendorById
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 vendor's id
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/VendorsResponse4'
- 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
/vendors:
get:
tags:
- Vendor
summary: getVendors
description: List of vendors
operationId: getVendors
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/VendorsResponse'
description: List of vendors
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/VendorsResponse'
description: List of vendors
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:
- Vendor
summary: createVendor
description: Create new vendor
operationId: createVendor
parameters:
- name: X-Samanage-Authorization
in: header
description: ''
style: simple
schema:
type: string
example: Bearer TOKEN
requestBody:
description: Vendor fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/VendorsRequest1'
- description: Vendor fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VendorsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/VendorsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/{object_type}/{id}/tasks:
post:
tags:
- Task
summary: createTask
description: Create new Task
operationId: createTask
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
requestBody:
description: Task fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TasksRequest'
- description: Task fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TasksResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/TasksResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/{object_type}/{id}/tasks/{task_id}:
put:
tags:
- Task
summary: updateTaskById
description: Update task with specified fields
operationId: updateTaskById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
- name: task_id
in: path
description: Numeric ID of the task
required: true
style: simple
schema:
type: string
requestBody:
description: Task fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TasksTaskIdRequest'
- description: Task fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TasksTaskIdResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/TasksTaskIdResponse'
- 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:
- Task
summary: deleteTaskById
description: Delete task
operationId: deleteTaskById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
- name: task_id
in: path
description: Numeric ID of the task
required: true
style: simple
schema:
type: string
responses:
'200':
description: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TasksTaskIdResponse2'
- example:
messages:
message: Deleted task
example:
messages:
message: Deleted task
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/{object_type}/{id}/comments:
post:
tags:
- Comment
summary: createComment
description: Create new Comment
operationId: createComment
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
requestBody:
description: Comment fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CommentsRequest'
- description: Comment fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CommentsResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/CommentsResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/{object_type}/{id}/comments/{comment_id}:
put:
tags:
- Comment
summary: updateCommentById
description: Update comment with specified fields
operationId: updateCommentById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
- name: comment_id
in: path
description: Numeric ID of the comment
required: true
style: simple
schema:
type: string
requestBody:
description: Comment fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CommentsCommentIdRequest'
- description: Comment fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CommentsCommentIdResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/CommentsCommentIdResponse'
- 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:
- Comment
summary: deleteCommentById
description: Delete comment
operationId: deleteCommentById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
- name: comment_id
in: path
description: Numeric ID of the comment
required: true
style: simple
schema:
type: string
responses:
'200':
description: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CommentsCommentIdResponse2'
- example:
messages:
message: Deleted comment
example:
messages:
message: Deleted comment
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/{object_type}/{id}/time_tracks:
get:
tags:
- Time Track
summary: getTimeTracks
description: List of time tracks
operationId: getTimeTracks
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
responses:
'200':
description: Object was returned correctly
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TimeTracksResponse'
description: List of time tracks
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/TimeTracksResponse'
description: List of time tracks
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:
- Time Track
summary: createTimeTrack
description: Create new time track
operationId: createTimeTrack
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
requestBody:
description: Time track fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TimeTracksRequest'
- description: Time track fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeTracksResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/TimeTracksResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/{object_type}/{id}/time_tracks/{time_track_id}:
put:
tags:
- Time Track
summary: updateTimeTrackyById
description: Update time track with specified fields
operationId: updateTimeTrackyById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
- name: time_track_id
in: path
description: Numeric ID of the time track
required: true
style: simple
schema:
type: string
requestBody:
description: Time track fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TimeTracksTimeTrackIdRequest'
- description: Time track fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TimeTracksTimeTrackIdResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/TimeTracksTimeTrackIdResponse'
- 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:
- Time Track
summary: deleteTimeTrackyById
description: Delete time track
operationId: deleteTimeTrackyById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
- name: time_track_id
in: path
description: Numeric ID of the time track
required: true
style: simple
schema:
type: string
responses:
'200':
description: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TimeTracksTimeTrackIdResponse2'
- example:
messages:
message: Deleted time track
example:
messages:
message: Deleted time track
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/{object_type}/{id}/purchases:
post:
tags:
- Purchase
summary: createPurchase
description: Create new purchase
operationId: createPurchase
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: contracts
requestBody:
description: Purchase fields to fill
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PurchasesRequest'
- description: Purchase fields to fill
required: true
responses:
'200':
description: Object created and returned correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PurchasesResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/PurchasesResponse'
- xml:
name: _
attribute: false
wrapped: false
example: <_ />
example: <_ />
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/{object_type}/{id}/purchases/{purchase_id}:
put:
tags:
- Purchase
summary: updatePurchaseById
description: Update purchase with specified fields
operationId: updatePurchaseById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: contracts / other_assets
- name: purchase_id
in: path
description: Numeric ID of the purchase
required: true
style: simple
schema:
type: string
requestBody:
description: Purchase fields to update
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PurchasesPurchaseIdRequest'
- description: Purchase fields to update
required: true
responses:
'200':
description: Object was updated correctly
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PurchasesPurchaseIdResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/PurchasesPurchaseIdResponse'
- 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:
- Purchase
summary: deletePurchaseById
description: Delete purchase
operationId: deletePurchaseById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: contracts
- name: purchase_id
in: path
description: Numeric ID of the purchase
required: true
style: simple
schema:
type: string
responses:
'200':
description: Message regarding a successful operation
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PurchasesPurchaseIdResponse2'
- example:
messages:
message: Deleted purchase
example:
messages:
message: Deleted purchase
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/audits:
get:
tags:
- Audit
summary: getAudits
description: List of audits
operationId: getAudits
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/AuditsResponse'
description: List of audits
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AuditsResponse'
description: List of audits
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
/{object_type}/{id}/audits:
get:
tags:
- Audit
summary: 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"'
operationId: getAuditById
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
- name: object_type
in: path
description: Source object type
required: true
style: simple
schema:
type: string
example: incidents
responses:
'200':
description: Object was returned correctly
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AuditsResponse'
description: List of audits of a specific object
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AuditsResponse'
description: List of audits of a specific object
xml:
name: /
attribute: false
wrapped: true
'400':
description: Bad request
headers: {}
content: {}
'404':
description: Not found
headers: {}
content: {}
'500':
description: Internal Server Error
headers: {}
content: {}
deprecated: false
/risks:
get:
tags:
- Risk
summary: getRisks
description: List of risks
operationId: getRisks
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/RisksResponse'
description: List of risks
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/RisksResponse'
description: List of risks
xml:
name: /
attribute: false
wrapped: true
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/attachments:
post:
tags:
- Attachment
summary: createAttachment
description: "Create a new attachment: curl -H 'X-Samanage-Authorization: Bearer TOKEN'
-F 'file[attachable_type]=PARENT_OBJECT_TYPE'
-F 'file[attachable_id]=PARENT_OBJECT_ID'
-F 'file[attachment]=@/PATH/TO/FILE'
-H 'Accept: application/vnd.samanage.v1.3+xml'
-H 'Content-Type: multipart/form-data'
-X POST https://api.samanage.com/attachments.xml/json
"
operationId: createAttachment
parameters: []
responses:
'200':
description: File successfully attached
headers: {}
content: {}
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
components:
schemas:
IncidentsResponse:
title: IncidentsResponse
type: object
properties:
incident:
$ref: '#/components/schemas/Incident'
xml:
name: _
attribute: false
wrapped: false
Incident:
title: Incident
type: object
properties:
id:
oneOf:
- type: string
example: 1
- type: integer
format: int32
readOnly: true
name:
type: string
description:
type: string
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
state:
type: string
priority:
type: string
assignee:
$ref: '#/components/schemas/Assignee'
requester:
$ref: '#/components/schemas/Requester'
category:
$ref: '#/components/schemas/Category'
subcategory:
$ref: '#/components/schemas/Subcategory'
due_at:
type: string
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValue'
description: ''
created_by:
$ref: '#/components/schemas/CreatedBy'
origin:
type: string
incidents:
type: array
items:
$ref: '#/components/schemas/Incident1'
description: ''
solutions:
type: array
items:
$ref: '#/components/schemas/Solution'
description: ''
changes:
type: array
items:
$ref: '#/components/schemas/Change'
description: ''
problems:
type: array
items:
$ref: '#/components/schemas/Problem'
description: ''
releases:
type: array
items:
$ref: '#/components/schemas/Release'
description: ''
configuration_items:
type: array
items:
$ref: '#/components/schemas/ConfigurationItem'
description: ''
is_service_request:
type: boolean
cc:
type: array
items:
type: string
description: "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\""
xml:
attribute: false
wrapped: true
Site:
title: Site
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Austin TX, USA
description:
type: string
example: AUS
location:
type: string
example: AUS
timezone:
type: string
example: UTC-6h
Department:
title: Department
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Support
description:
type: string
example: Support Department
default_assignee_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
Assignee:
title: Assignee
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
Avatar:
title: Avatar
type: object
properties:
type:
type: string
example: initials
color:
type: string
example: '#1000'
initials:
maxLength: 2
minLength: 2
type: string
example: JD
Requester:
title: Requester
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
account_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
user_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
email:
type: string
example: john.doe@email.com
name:
type: string
example: John Doe
disabled:
type: boolean
example: false
avatar:
$ref: '#/components/schemas/Avatar'
Category:
title: Category
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Category / Subcategory name
default_tags:
type: string
example: tag1, tag2
parent_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
default_assignee_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
Subcategory:
title: Subcategory
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Category / Subcategory name
default_tags:
type: string
example: tag1, tag2
parent_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
default_assignee_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
CustomFieldsValue:
title: CustomFieldsValue
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
custom_field_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: ' Name of custom text field'
value:
type: string
example: content
type_name:
type: string
example: Text
CreatedBy:
title: CreatedBy
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
account_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
user_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
email:
type: string
example: john.doe@email.com
name:
type: string
example: John Doe
disabled:
type: boolean
example: false
avatar:
$ref: '#/components/schemas/Avatar'
Incident1:
title: Incident1
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
Solution:
title: Solution
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
Change:
title: Change
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
Problem:
title: Problem
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
Release:
title: Release
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
ConfigurationItem:
title: ConfigurationItem
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
IncidentsRequest:
title: IncidentsRequest
type: object
properties:
incident:
$ref: '#/components/schemas/Incident4'
xml:
name: _
attribute: false
wrapped: false
Incident4:
title: Incident4
type: object
properties:
name:
type: string
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description:
type: string
state_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
assignee_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
priority:
anyOf:
- type: string
example: 1
- type: integer
format: int32
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
category:
oneOf:
- $ref: '#/components/schemas/Category2'
- $ref: '#/components/schemas/Category21'
subcategory:
oneOf:
- $ref: '#/components/schemas/Subcategory2'
- $ref: '#/components/schemas/Subcategory21'
due_at:
type: string
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incidents:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Incident5'
- $ref: '#/components/schemas/Incidents'
solutions:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Solution2'
- $ref: '#/components/schemas/Solutions'
changes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Change2'
- $ref: '#/components/schemas/Changes'
problems:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Problem2'
- $ref: '#/components/schemas/Problems'
releases:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Release2'
- $ref: '#/components/schemas/Releases'
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
cc:
type: array
items:
type: string
description: "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\""
xml:
attribute: false
wrapped: true
Assignee2:
title: Assignee2
required:
- email
type: object
properties:
email:
type: string
example: john.doe@email.com
Assignee21:
title: Assignee21
enum:
- nil
type: string
Requester2:
title: Requester2
required:
- email
type: object
properties:
email:
type: string
example: john.doe@email.com
Requester21:
title: Requester21
enum:
- nil
type: string
Category2:
title: Category2
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Category21:
title: Category21
enum:
- nil
type: string
Subcategory2:
title: Subcategory2
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Subcategory21:
title: Subcategory21
enum:
- nil
type: string
CustomFieldsValues:
title: CustomFieldsValues
required:
- custom_fields_value
type: object
properties:
custom_fields_value:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValue2'
- $ref: '#/components/schemas/CustomFieldsValue2'
CustomFieldsValue2:
title: CustomFieldsValue2
required:
- name
type: object
properties:
name:
type: string
example: Name of custom text field
value:
anyOf:
- type: string
example: content
- type: integer
format: int32
example: 1
- {}
user_value:
oneOf:
- $ref: '#/components/schemas/UserValue'
- $ref: '#/components/schemas/UserValue1'
UserValue:
title: UserValue
required:
- email
type: object
properties:
email:
type: string
example: john.doe@email.com
UserValue1:
title: UserValue1
enum:
- nil
type: string
CustomFieldsValue22:
title: CustomFieldsValue22
type: object
properties:
name:
type: string
example: Name of custom text field
value:
anyOf:
- type: string
example: content
- type: integer
format: int32
example: 1
- {}
user_value:
oneOf:
- $ref: '#/components/schemas/UserValue'
- $ref: '#/components/schemas/UserValue1'
CustomFieldsValuesAttribute:
title: CustomFieldsValuesAttribute
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
custom_field_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
value:
anyOf:
- type: string
example: content
- type: integer
format: int32
example: 1
- {}
Incident5:
title: Incident5
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Incidents:
title: Incidents
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Solution2:
title: Solution2
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Solutions:
title: Solutions
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Change2:
title: Change2
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Changes:
title: Changes
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Problem2:
title: Problem2
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Problems:
title: Problems
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Release2:
title: Release2
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Releases:
title: Releases
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
IncidentsResponse2:
title: IncidentsResponse2
type: object
properties:
incident:
$ref: '#/components/schemas/Incident6'
xml:
name: _
attribute: false
wrapped: false
Incident6:
title: Incident6
type: object
properties:
id:
oneOf:
- type: string
example: 1
- type: integer
format: int32
readOnly: true
name:
type: string
description:
type: string
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
state:
type: string
priority:
type: string
assignee:
$ref: '#/components/schemas/Assignee'
requester:
$ref: '#/components/schemas/Requester'
category:
$ref: '#/components/schemas/Category'
subcategory:
$ref: '#/components/schemas/Subcategory'
due_at:
type: string
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
created_by:
$ref: '#/components/schemas/CreatedBy'
origin:
type: string
incidents:
type: array
items:
$ref: '#/components/schemas/Incidents2'
description: ''
solutions:
type: array
items:
$ref: '#/components/schemas/Solutions2'
description: ''
changes:
type: array
items:
$ref: '#/components/schemas/Changes2'
description: ''
problems:
type: array
items:
$ref: '#/components/schemas/Problems2'
description: ''
releases:
type: array
items:
$ref: '#/components/schemas/Releases2'
description: ''
configuration_items:
type: array
items:
$ref: '#/components/schemas/ConfigurationItem'
description: ''
is_service_request:
type: boolean
cc:
type: array
items:
type: string
description: "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\""
xml:
attribute: false
wrapped: true
CustomFieldsValues1:
title: CustomFieldsValues1
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
custom_field_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: ' Name of custom text field'
value:
type: string
example: content
type_name:
type: string
example: Text
Incidents2:
title: Incidents2
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
Solutions2:
title: Solutions2
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
Changes2:
title: Changes2
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
Problems2:
title: Problems2
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
Releases2:
title: Releases2
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
IncidentsResponse4:
title: IncidentsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
IncidentsRequest1:
title: IncidentsRequest1
type: object
properties:
incident:
$ref: '#/components/schemas/Incident10'
xml:
name: _
attribute: false
wrapped: false
Incident10:
title: Incident10
required:
- name
type: object
properties:
name:
type: string
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description:
type: string
state_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
assignee_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
priority:
anyOf:
- type: string
example: 1
- type: integer
format: int32
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
category:
oneOf:
- $ref: '#/components/schemas/Category2'
- $ref: '#/components/schemas/Category21'
subcategory:
oneOf:
- $ref: '#/components/schemas/Subcategory2'
- $ref: '#/components/schemas/Subcategory21'
due_at:
type: string
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incidents:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Incidents'
- $ref: '#/components/schemas/Incidents'
solutions:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Solutions'
- $ref: '#/components/schemas/Solutions'
changes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Changes'
- $ref: '#/components/schemas/Changes'
problems:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Problems'
- $ref: '#/components/schemas/Problems'
releases:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Releases'
- $ref: '#/components/schemas/Releases'
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
cc:
type: array
items:
type: string
description: "for xml requests, please add: type=\"array\". for example: \"\\ \\john.doe@email.com\\ \\\""
xml:
attribute: false
wrapped: true
ProblemsResponse:
title: ProblemsResponse
type: object
properties:
problem:
$ref: '#/components/schemas/Problem3'
xml:
name: _
attribute: false
wrapped: false
Problem3:
title: Problem3
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Problem Name
description:
type: string
example: description
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
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:
$ref: '#/components/schemas/CreatedBy'
assignee:
$ref: '#/components/schemas/Assignee'
requester:
$ref: '#/components/schemas/Requester'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
incidents:
type: array
items:
$ref: '#/components/schemas/Incidents2'
description: ''
changes:
type: array
items:
$ref: '#/components/schemas/Changes2'
description: ''
configuration_items:
type: array
items:
$ref: '#/components/schemas/ConfigurationItem'
description: ''
Tag:
title: Tag
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: tag name
taggings_count:
type: integer
format: int32
example: 1
ProblemsRequest:
title: ProblemsRequest
type: object
properties:
problem:
$ref: '#/components/schemas/Problem5'
xml:
name: _
attribute: false
wrapped: false
Problem5:
title: Problem5
type: object
properties:
name:
type: string
description:
type: string
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
state:
type: string
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
priority:
type: string
root_cause:
type: string
symptoms:
type: string
workaround:
type: string
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incident_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
itsm_change_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
Site10:
title: Site10
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Site101:
title: Site101
enum:
- nil
type: string
Department10:
title: Department10
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Department101:
title: Department101
enum:
- nil
type: string
ProblemsResponse4:
title: ProblemsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
ProblemsRequest1:
title: ProblemsRequest1
type: object
properties:
problem:
$ref: '#/components/schemas/Problem10'
xml:
name: _
attribute: false
wrapped: false
Problem10:
title: Problem10
required:
- name
type: object
properties:
name:
type: string
description:
type: string
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
state:
type: string
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
priority:
type: string
root_cause:
type: string
symptoms:
type: string
workaround:
type: string
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incident_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
itsm_change_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
ChangesResponse:
title: ChangesResponse
type: object
properties:
change:
$ref: '#/components/schemas/Change3'
xml:
name: _
attribute: false
wrapped: false
Change3:
title: Change3
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Change Name
description:
type: string
example: description
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
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:
$ref: '#/components/schemas/CreatedBy'
assignee:
$ref: '#/components/schemas/Assignee'
requester:
$ref: '#/components/schemas/Requester'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
created_at:
type: string
example: 2025-01-01T00:00:00.000+01:00
incidents:
type: array
items:
$ref: '#/components/schemas/Incidents2'
description: ''
changes:
type: array
items:
$ref: '#/components/schemas/Changes2'
description: ''
configuration_items:
type: array
items:
$ref: '#/components/schemas/ConfigurationItem'
description: ''
ChangesRequest:
title: ChangesRequest
type: object
properties:
change:
$ref: '#/components/schemas/Change5'
xml:
name: _
attribute: false
wrapped: false
Change5:
title: Change5
type: object
properties:
name:
type: string
change_type:
type: integer
format: int32
description:
type: string
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
state:
type: string
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
priority:
type: string
change_plan:
type: string
rollback_plan:
type: string
test_plan:
type: string
planned_start_at:
type: string
planned_end_at:
type: string
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incidents:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Incidents'
- $ref: '#/components/schemas/Incidents'
problems:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Problems'
- $ref: '#/components/schemas/Problems'
releases:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Releases'
- $ref: '#/components/schemas/Releases'
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
ChangesResponse4:
title: ChangesResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
ChangesRequest1:
title: ChangesRequest1
type: object
properties:
change:
$ref: '#/components/schemas/Change10'
xml:
name: _
attribute: false
wrapped: false
Change10:
title: Change10
required:
- name
- change_type
type: object
properties:
name:
type: string
change_type:
type: integer
format: int32
description:
type: string
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
state:
type: string
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
priority:
type: string
change_plan:
type: string
rollback_plan:
type: string
test_plan:
type: string
planned_start_at:
type: string
planned_end_at:
type: string
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incidents:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Incidents'
- $ref: '#/components/schemas/Incidents'
problems:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Problems'
- $ref: '#/components/schemas/Problems'
releases:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Releases'
- $ref: '#/components/schemas/Releases'
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
ChangeCatalogsResponse:
title: ChangeCatalogsResponse
type: object
properties:
change_catalog:
$ref: '#/components/schemas/ChangeCatalog'
xml:
name: _
attribute: false
wrapped: false
ChangeCatalog:
title: ChangeCatalog
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Change Name
description:
type: string
example: description
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
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:
$ref: '#/components/schemas/CreatedBy'
default_assignee:
$ref: '#/components/schemas/DefaultAssignee'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
created_at:
type: string
example: 2025-01-01T00:00:00.000+01:00
show_in_portal:
type: boolean
example: true
DefaultAssignee:
title: DefaultAssignee
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
ChangeCatalogsRequest:
title: ChangeCatalogsRequest
type: object
properties:
change_catalog:
$ref: '#/components/schemas/ChangeCatalog2'
xml:
name: _
attribute: false
wrapped: false
ChangeCatalog2:
title: ChangeCatalog2
type: object
properties:
name:
type: string
example: Change Name
change_type:
type: integer
format: int32
example: 1
description:
type: string
example: description
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
state:
type: string
example: Approved
default_assignee_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
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:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
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
ChangeCatalogsResponse4:
title: ChangeCatalogsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
ChangeCatalogsRequest1:
title: ChangeCatalogsRequest1
type: object
properties:
change_catalog:
$ref: '#/components/schemas/ChangeCatalog7'
xml:
name: _
attribute: false
wrapped: false
ChangeCatalog7:
title: ChangeCatalog7
required:
- name
- change_type
type: object
properties:
name:
type: string
example: Change Name
change_type:
type: integer
format: int32
example: 1
description:
type: string
example: description
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
state:
type: string
example: Approved
default_assignee_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
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:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
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
ReleasesResponse:
title: ReleasesResponse
type: object
properties:
release:
$ref: '#/components/schemas/Release3'
xml:
name: _
attribute: false
wrapped: false
Release3:
title: Release3
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Release Name
description:
type: string
example: description
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
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:
$ref: '#/components/schemas/CreatedBy'
assignee:
$ref: '#/components/schemas/Assignee'
requester:
$ref: '#/components/schemas/Requester'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
created_at:
type: string
example: 2025-01-01T00:00:00.000+01:00
changes:
type: array
items:
$ref: '#/components/schemas/Changes2'
description: ''
configuration_items:
type: array
items:
$ref: '#/components/schemas/ConfigurationItem'
description: ''
approvers:
type: array
items:
$ref: '#/components/schemas/Approver'
description: ''
Approver:
title: Approver
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
ReleasesRequest:
title: ReleasesRequest
type: object
properties:
release:
$ref: '#/components/schemas/Release5'
xml:
name: _
attribute: false
wrapped: false
Release5:
title: Release5
type: object
properties:
name:
type: string
description:
type: string
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
state:
type: string
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
priority:
type: string
plan:
type: string
build:
type: string
deploy:
type: string
planned_start_at:
type: string
planned_end_at:
type: string
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
itsm_change_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
approval_levels_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ApprovalLevelsAttribute'
- type: array
items:
$ref: '#/components/schemas/ApprovalLevelsAttribute'
ApprovalLevelsAttribute:
title: ApprovalLevelsAttribute
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
approver_ids:
type: string
example: 1, 2
approval_condition:
type: string
example: '1'
ReleasesResponse4:
title: ReleasesResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
ReleasesRequest1:
title: ReleasesRequest1
type: object
properties:
release:
$ref: '#/components/schemas/Release10'
xml:
name: _
attribute: false
wrapped: false
Release10:
title: Release10
required:
- name
- requester
type: object
properties:
name:
type: string
description:
type: string
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
state:
type: string
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
priority:
type: string
plan:
type: string
build:
type: string
deploy:
type: string
planned_start_at:
type: string
planned_end_at:
type: string
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
itsm_change_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
approval_levels_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ApprovalLevelsAttribute'
- type: array
items:
$ref: '#/components/schemas/ApprovalLevelsAttribute'
SolutionsResponse:
title: SolutionsResponse
type: object
properties:
solution:
$ref: '#/components/schemas/Solution3'
xml:
name: _
attribute: false
wrapped: false
Solution3:
title: Solution3
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Solution Name
description:
type: string
example: description
creator:
$ref: '#/components/schemas/Creator'
created_at:
type: string
example: 2025-01-01T00:00:00.000+01:00
origin:
type: string
example: api
Creator:
title: Creator
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: tag name
email:
type: string
example: john.doe@email.com
SolutionsRequest:
title: SolutionsRequest
type: object
properties:
solution:
$ref: '#/components/schemas/Solution5'
xml:
name: _
attribute: false
wrapped: false
Solution5:
title: Solution5
type: object
properties:
name:
type: string
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description:
type: string
state:
type: string
category:
oneOf:
- $ref: '#/components/schemas/Category2'
- $ref: '#/components/schemas/Category21'
subcategory:
oneOf:
- $ref: '#/components/schemas/Subcategory2'
- $ref: '#/components/schemas/Subcategory21'
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incident_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
SolutionsResponse4:
title: SolutionsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
SolutionsRequest1:
title: SolutionsRequest1
type: object
properties:
solution:
$ref: '#/components/schemas/Solution10'
xml:
name: _
attribute: false
wrapped: false
Solution10:
title: Solution10
required:
- name
type: object
properties:
name:
type: string
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description:
type: string
state:
type: string
category:
oneOf:
- $ref: '#/components/schemas/Category2'
- $ref: '#/components/schemas/Category21'
subcategory:
oneOf:
- $ref: '#/components/schemas/Subcategory2'
- $ref: '#/components/schemas/Subcategory21'
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incident_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
CatalogItemsResponse:
title: CatalogItemsResponse
type: object
properties:
catalog_item:
$ref: '#/components/schemas/CatalogItem'
xml:
name: _
attribute: false
wrapped: false
CatalogItem:
title: CatalogItem
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
$ref: '#/components/schemas/Tag'
description: ''
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
category:
$ref: '#/components/schemas/Category'
subcategory:
$ref: '#/components/schemas/Subcategory'
origin:
type: string
example: api
CatalogItemsRequest:
title: CatalogItemsRequest
type: object
properties:
catalog_item:
$ref: '#/components/schemas/CatalogItem2'
xml:
name: _
attribute: false
wrapped: false
CatalogItem2:
title: CatalogItem2
type: object
properties:
name:
type: string
example: CI Name
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description:
type: string
example: description
state:
type: string
example: Approved
default_assignee_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
category:
oneOf:
- $ref: '#/components/schemas/Category2'
- $ref: '#/components/schemas/Category21'
subcategory:
oneOf:
- $ref: '#/components/schemas/Subcategory2'
- $ref: '#/components/schemas/Subcategory21'
expected_delivery_time:
type: string
example: 1 day
currency:
type: string
example: USD
price:
type: string
example: '1'
show_price:
anyOf:
- type: string
example: '1'
- type: boolean
example: true
add_to_tag_list:
type: string
example: tag1, tag2
remove_from_tag_list:
type: string
example: tag3
tag_list:
type: string
example: tag1, tag2
CatalogItemsResponse4:
title: CatalogItemsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
CatalogItemsRequest1:
title: CatalogItemsRequest1
type: object
properties:
catalog_item:
$ref: '#/components/schemas/CatalogItem7'
xml:
name: _
attribute: false
wrapped: false
CatalogItem7:
title: CatalogItem7
required:
- name
- category
type: object
properties:
name:
type: string
example: CI Name
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description:
type: string
example: description
state:
type: string
example: Approved
default_assignee_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
category:
oneOf:
- $ref: '#/components/schemas/Category2'
- $ref: '#/components/schemas/Category21'
subcategory:
oneOf:
- $ref: '#/components/schemas/Subcategory2'
- $ref: '#/components/schemas/Subcategory21'
expected_delivery_time:
type: string
example: 1 day
currency:
type: string
example: USD
price:
type: string
example: '1'
show_price:
anyOf:
- type: string
example: '1'
- type: boolean
example: true
add_to_tag_list:
type: string
example: tag1, tag2
remove_from_tag_list:
type: string
example: tag3
tag_list:
type: string
example: tag1, tag2
CatalogItemsServiceRequestsRequest:
title: CatalogItemsServiceRequestsRequest
type: object
properties:
incident:
$ref: '#/components/schemas/Incident13'
xml:
name: _
attribute: false
wrapped: false
Incident13:
title: Incident13
type: object
properties:
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
requester_name:
type: string
example: john.doe@email.com
priority:
type: string
example: High
due_at:
type: string
example: Jan 01,2025
add_to_tag_list:
type: string
example: tag1, tag2
remove_from_tag_list:
type: string
example: tag3
tag_list:
type: string
example: tag1, tag2
request_variables_attributes:
anyOf:
- $ref: '#/components/schemas/RequestVariablesAttributes'
- type: array
items:
$ref: '#/components/schemas/RequestVariablesAttributes'
RequestVariablesAttributes:
title: RequestVariablesAttributes
required:
- name
type: object
properties:
name:
type: string
example: Variable name
value:
type: string
example: Content
user_value:
oneOf:
- $ref: '#/components/schemas/UserValue'
- $ref: '#/components/schemas/UserValue1'
RequestVariablesAttributes2:
title: RequestVariablesAttributes2
type: object
properties:
name:
type: string
example: Variable name
value:
type: string
example: Content
user_value:
oneOf:
- $ref: '#/components/schemas/UserValue'
- $ref: '#/components/schemas/UserValue1'
CatalogItemsServiceRequestsResponse:
title: CatalogItemsServiceRequestsResponse
type: object
properties:
incident:
$ref: '#/components/schemas/Incident6'
xml:
name: _
attribute: false
wrapped: false
ConfigurationItemsResponse:
title: ConfigurationItemsResponse
type: object
properties:
configuration_item:
$ref: '#/components/schemas/ConfigurationItem34'
xml:
name: _
attribute: false
wrapped: false
ConfigurationItem34:
title: ConfigurationItem34
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: CI Name
description:
type: string
example: description
type:
$ref: '#/components/schemas/Type'
type_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
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:
$ref: '#/components/schemas/Tag'
description: ''
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
state:
type: string
example: Active
manager_id:
$ref: '#/components/schemas/ManagerId'
user_id:
$ref: '#/components/schemas/UserId'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
incidents:
type: array
items:
$ref: '#/components/schemas/Incidents2'
description: ''
changes:
type: array
items:
$ref: '#/components/schemas/Changes2'
description: ''
problems:
type: array
items:
$ref: '#/components/schemas/Problems2'
description: ''
releases:
type: array
items:
$ref: '#/components/schemas/Releases2'
description: ''
purchase_orders:
type: array
items:
$ref: '#/components/schemas/PurchaseOrder'
description: ''
configuration_items:
type: array
items:
$ref: '#/components/schemas/ConfigurationItem'
description: ''
origin:
type: string
example: api
Type:
title: Type
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Building
description:
type: string
example: Configuration Item - Building
parent_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
custom:
type: boolean
example: false
icon_name:
type: string
example: BUILDING
updated_at:
type: string
example: 2025-01-01T00:00:00.000+01:00
ManagerId:
title: ManagerId
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
UserId:
title: UserId
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
PurchaseOrder:
title: PurchaseOrder
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
href:
type: string
example: https://mydomain.com/object_type/1
ConfigurationItemsRequest:
title: ConfigurationItemsRequest
type: object
properties:
configuration_item:
$ref: '#/components/schemas/ConfigurationItem38'
xml:
name: _
attribute: false
wrapped: false
ConfigurationItem38:
title: ConfigurationItem38
type: object
properties:
type:
oneOf:
- $ref: '#/components/schemas/Type2'
- $ref: '#/components/schemas/Type21'
type_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
name:
type: string
description:
type: string
asset_tag:
type: string
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
state:
type: string
manager:
oneOf:
- $ref: '#/components/schemas/Manager'
- $ref: '#/components/schemas/Manager1'
user:
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/User1'
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incident_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
itsm_change_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
problem_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
purchase_order_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
release_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
Type2:
title: Type2
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Type21:
title: Type21
enum:
- nil
type: string
Manager:
title: Manager
required:
- email
type: object
properties:
email:
type: string
example: john.doe@email.com
Manager1:
title: Manager1
enum:
- nil
type: string
User:
title: User
required:
- email
type: object
properties:
email:
type: string
example: john.doe@email.com
User1:
title: User1
enum:
- nil
type: string
ConfigurationItemsResponse4:
title: ConfigurationItemsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
ConfigurationItemsRequest1:
title: ConfigurationItemsRequest1
type: object
properties:
configuration_item:
$ref: '#/components/schemas/ConfigurationItem47'
xml:
name: _
attribute: false
wrapped: false
ConfigurationItem47:
title: ConfigurationItem47
required:
- name
type: object
properties:
type:
oneOf:
- $ref: '#/components/schemas/Type2'
- $ref: '#/components/schemas/Type21'
type_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
name:
type: string
description:
type: string
asset_tag:
type: string
site_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
department_id:
anyOf:
- type: string
example: 1
- type: integer
format: int32
state:
type: string
manager:
oneOf:
- $ref: '#/components/schemas/Manager'
- $ref: '#/components/schemas/Manager1'
user:
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/User1'
add_to_tag_list:
type: string
remove_from_tag_list:
type: string
tag_list:
type: string
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
incident_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
itsm_change_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
problem_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
purchase_order_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
release_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
configuration_item_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
ConfigurationItemsAppendMultipleDependentAssetsRequest:
title: ConfigurationItemsAppendMultipleDependentAssetsRequest
type: object
properties:
selected_ids:
$ref: '#/components/schemas/SelectedIds'
SelectedIds:
title: SelectedIds
type: object
properties:
configuration_items:
type: array
items:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description: ''
mobiles:
type: array
items:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description: ''
hardwares:
type: array
items:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description: ''
discovery_hardwares:
type: array
items:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description: ''
other_assets:
type: array
items:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description: ''
AssetLinksDeleteAssetLinkByIdRequest:
title: AssetLinksDeleteAssetLinkByIdRequest
type: object
properties:
assetLinkId:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: The id of the dependency between the assets
sourceId:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: The id of the configuration item
sourceType:
type: string
xml:
name: _
attribute: false
wrapped: false
UsersResponse:
title: UsersResponse
type: object
properties:
user:
$ref: '#/components/schemas/User3'
xml:
name: _
attribute: false
wrapped: false
User3:
title: User3
type: object
properties:
id:
oneOf:
- type: string
example: 1
- type: integer
format: int32
readOnly: true
name:
type: string
title:
type: string
email:
type: string
phone:
type: string
mobile_phone:
type: string
role:
$ref: '#/components/schemas/Role'
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
avatar:
$ref: '#/components/schemas/Avatar'
reports_to:
$ref: '#/components/schemas/ReportsTo'
group_ids:
type: array
items:
anyOf:
- type: string
example: 1
- type: integer
format: int32
description: 'for xml requests, please add: type="array", for example: 1'
xml:
attribute: false
wrapped: true
created_at:
type: string
Role:
title: Role
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Requester
description:
type: string
example: Requester role
portal:
type: boolean
example: true
show_my_tasks:
type: boolean
example: true
ReportsTo:
title: ReportsTo
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
UsersRequest:
title: UsersRequest
type: object
properties:
user:
$ref: '#/components/schemas/User5'
xml:
name: _
attribute: false
wrapped: false
User5:
title: User5
type: object
properties:
name:
type: string
example: John Doe
title:
type: string
example: Support Agent
email:
type: string
example: john.doe@email.com
disabled:
type: boolean
example: false
phone:
type: string
example: '+10000000'
mobile_phone:
type: string
example: '+10000000'
role:
oneOf:
- $ref: '#/components/schemas/Role2'
- $ref: '#/components/schemas/Role21'
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
reports_to:
oneOf:
- $ref: '#/components/schemas/ReportsTo2'
- oneOf:
- $ref: '#/components/schemas/ReportsTo21'
- $ref: '#/components/schemas/ReportsTo211'
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
Role2:
title: Role2
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Role21:
title: Role21
enum:
- nil
type: string
ReportsTo2:
title: ReportsTo2
required:
- id
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
ReportsTo21:
title: ReportsTo21
required:
- email
type: object
properties:
email:
type: string
example: john.doe@email.com
ReportsTo211:
title: ReportsTo211
enum:
- nil
type: string
UsersResponse4:
title: UsersResponse4
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted user
UsersRequest1:
title: UsersRequest1
type: object
properties:
user:
$ref: '#/components/schemas/User10'
xml:
name: _
attribute: false
wrapped: false
User10:
title: User10
required:
- name
- email
type: object
properties:
name:
type: string
example: John Doe
title:
type: string
example: Support Agent
email:
type: string
example: john.doe@email.com
disabled:
type: boolean
example: false
phone:
type: string
example: '+10000000'
mobile_phone:
type: string
example: '+10000000'
role:
oneOf:
- $ref: '#/components/schemas/Role2'
- $ref: '#/components/schemas/Role21'
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
reports_to:
oneOf:
- $ref: '#/components/schemas/ReportsTo2'
- oneOf:
- $ref: '#/components/schemas/ReportsTo21'
- $ref: '#/components/schemas/ReportsTo211'
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
SitesResponse:
title: SitesResponse
type: object
properties:
site:
$ref: '#/components/schemas/Site76'
xml:
name: _
attribute: false
wrapped: false
Site76:
title: Site76
required:
- name
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
maxLength: 2
minLength: 2
type: string
example: en
business_record:
type: string
example: '1'
SitesRequest:
title: SitesRequest
type: object
properties:
site:
$ref: '#/components/schemas/Site78'
xml:
name: _
attribute: false
wrapped: false
Site78:
title: Site78
type: object
properties:
name:
type: string
example: Austin TX, USA
location:
type: string
example: AUS
description:
type: string
example: Description Austin TX, USA
time_zone:
type: string
example: Texas
language:
maxLength: 2
minLength: 2
type: string
example: en
manager_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description: user only, not group
default_assignee_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
business_record:
$ref: '#/components/schemas/BusinessRecord'
BusinessRecord:
title: BusinessRecord
type: object
properties:
id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
SitesResponse4:
title: SitesResponse4
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted site
SitesRequest1:
title: SitesRequest1
type: object
properties:
site:
$ref: '#/components/schemas/Site83'
xml:
name: _
attribute: false
wrapped: false
Site83:
title: Site83
required:
- name
- location
type: object
properties:
name:
type: string
example: Austin TX, USA
location:
type: string
example: AUS
description:
type: string
example: Description Austin TX, USA
time_zone:
type: string
example: Texas
language:
maxLength: 2
minLength: 2
type: string
example: en
manager_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
description: user only, not group
default_assignee_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
business_record:
$ref: '#/components/schemas/BusinessRecord'
DepartmentsResponse:
title: DepartmentsResponse
type: object
properties:
department:
$ref: '#/components/schemas/Department76'
xml:
name: _
attribute: false
wrapped: false
Department76:
title: Department76
required:
- name
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Support
description:
type: string
example: Support Department
DepartmentsRequest:
title: DepartmentsRequest
type: object
properties:
department:
$ref: '#/components/schemas/Department78'
xml:
name: _
attribute: false
wrapped: false
Department78:
title: Department78
type: object
properties:
name:
type: string
example: Support
description:
type: string
example: Support Department
DepartmentsResponse4:
title: DepartmentsResponse4
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted department
DepartmentsRequest1:
title: DepartmentsRequest1
type: object
properties:
department:
$ref: '#/components/schemas/Department83'
xml:
name: _
attribute: false
wrapped: false
Department83:
title: Department83
required:
- name
type: object
properties:
name:
type: string
example: Support
description:
type: string
example: Support Department
RolesResponse:
title: RolesResponse
type: object
properties:
role:
$ref: '#/components/schemas/Role10'
xml:
name: _
attribute: false
wrapped: false
Role10:
title: Role10
required:
- name
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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
RolesRequest:
title: RolesRequest
type: object
properties:
role:
$ref: '#/components/schemas/Role12'
xml:
name: _
attribute: false
wrapped: false
Role12:
title: Role12
type: object
properties:
name:
type: string
example: Support Agent
description:
type: string
example: Support Agent role
portal:
type: boolean
example: true
RolesResponse4:
title: RolesResponse4
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted role
RolesRequest1:
title: RolesRequest1
type: object
properties:
role:
$ref: '#/components/schemas/Role17'
xml:
name: _
attribute: false
wrapped: false
Role17:
title: Role17
required:
- name
type: object
properties:
name:
type: string
example: Support Agent
description:
type: string
example: Support Agent role
portal:
type: boolean
example: true
GroupsResponse:
title: GroupsResponse
type: object
properties:
group:
$ref: '#/components/schemas/Group'
xml:
name: _
attribute: false
wrapped: false
Group:
title: Group
required:
- name
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Group Name
description:
type: string
example: Group Description
is_user:
type: boolean
example: false
reports_to:
$ref: '#/components/schemas/ReportsTo'
avatar:
$ref: '#/components/schemas/Avatar'
send_notifications:
type: boolean
example: true
memberships:
type: array
items:
$ref: '#/components/schemas/Membership'
description: ''
Membership:
title: Membership
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
user:
type: string
example: John Doe
GroupsRequest:
title: GroupsRequest
type: object
properties:
group:
$ref: '#/components/schemas/Group2'
xml:
name: _
attribute: false
wrapped: false
Group2:
title: Group2
type: object
properties:
name:
type: string
example: Group Name
description:
type: string
example: Group Description
superviser_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
GroupsResponse4:
title: GroupsResponse4
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted group
GroupsRequest1:
title: GroupsRequest1
type: object
properties:
group:
$ref: '#/components/schemas/Group7'
xml:
name: _
attribute: false
wrapped: false
Group7:
title: Group7
required:
- name
type: object
properties:
name:
type: string
example: Group Name
description:
type: string
example: Group Description
superviser_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
CategoriesResponse:
title: CategoriesResponse
type: object
properties:
category:
$ref: '#/components/schemas/Category'
xml:
name: _
attribute: false
wrapped: false
CategoriesRequest:
title: CategoriesRequest
type: object
properties:
category:
$ref: '#/components/schemas/Category27'
xml:
name: _
attribute: false
wrapped: false
Category27:
title: Category27
type: object
properties:
name:
type: string
example: Equipment
parent:
oneOf:
- $ref: '#/components/schemas/Parent'
- $ref: '#/components/schemas/Parent1'
example:
name: Facilities
default_assignee_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
default_tags:
type: string
example: equipment
Parent:
title: Parent
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Parent1:
title: Parent1
enum:
- nil
type: string
CategoriesResponse4:
title: CategoriesResponse4
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted category
CategoriesRequest1:
title: CategoriesRequest1
type: object
properties:
category:
$ref: '#/components/schemas/Category32'
xml:
name: _
attribute: false
wrapped: false
Category32:
title: Category32
required:
- name
type: object
properties:
name:
type: string
example: Equipment
parent:
oneOf:
- $ref: '#/components/schemas/Parent'
- $ref: '#/components/schemas/Parent1'
example:
name: Facilities
default_assignee_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
default_tags:
type: string
example: equipment
HardwaresResponse:
title: HardwaresResponse
type: object
properties:
hardware:
$ref: '#/components/schemas/Hardware'
xml:
name: _
attribute: false
wrapped: false
Hardware:
title: Hardware
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Hardware Name
ip:
type: string
example: 0.0.0.0
description:
type: string
example: description
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
status:
type: string
example: Operational
category:
$ref: '#/components/schemas/Category35'
owner:
$ref: '#/components/schemas/Owner'
technical_contact:
$ref: '#/components/schemas/TechnicalContact'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
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
format: int32
example: 1
bio:
type: array
items:
$ref: '#/components/schemas/Bio'
description: ''
tag:
type: string
example: hardware tag
asset_tag:
type: string
example: '1'
Category35:
title: Category35
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Laptop
Owner:
title: Owner
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
TechnicalContact:
title: TechnicalContact
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
Bio:
title: Bio
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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
HardwaresRequest:
title: HardwaresRequest
type: object
properties:
hardware:
$ref: '#/components/schemas/Hardware2'
xml:
name: _
attribute: false
wrapped: false
Hardware2:
title: Hardware2
type: object
properties:
name:
type: string
example: Hardware Name
description:
type: string
example: description
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
category:
oneOf:
- $ref: '#/components/schemas/Category2'
- $ref: '#/components/schemas/Category21'
ip_address:
type: string
example: 0.0.0.0
external_ip:
type: string
example: 0.0.0.0
status:
oneOf:
- $ref: '#/components/schemas/Status'
- $ref: '#/components/schemas/Status1'
technical_contact:
oneOf:
- $ref: '#/components/schemas/TechnicalContact2'
- $ref: '#/components/schemas/TechnicalContact21'
owner:
oneOf:
- $ref: '#/components/schemas/Owner2'
- $ref: '#/components/schemas/Owner21'
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
format: int32
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
format: int32
example: 1
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
bio:
$ref: '#/components/schemas/Bio2'
tag:
type: string
example: hardware tag
asset_tag:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
Status:
title: Status
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Status1:
title: Status1
enum:
- nil
type: string
TechnicalContact2:
title: TechnicalContact2
required:
- email
type: object
properties:
email:
type: string
example: john.doe@email.com
TechnicalContact21:
title: TechnicalContact21
enum:
- nil
type: string
Owner2:
title: Owner2
required:
- email
type: object
properties:
email:
type: string
example: john.doe@email.com
Owner21:
title: Owner21
enum:
- nil
type: string
Bio2:
title: Bio2
type: object
properties:
manufacturer:
type: string
example: Dell
ssn:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
model:
type: string
example: model description
version:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
bios_date:
type: string
example: 2020-01-01 00:00
HardwaresResponse4:
title: HardwaresResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
HardwaresRequest1:
title: HardwaresRequest1
type: object
properties:
hardware:
$ref: '#/components/schemas/Hardware7'
xml:
name: _
attribute: false
wrapped: false
Hardware7:
title: Hardware7
required:
- name
type: object
properties:
name:
type: string
example: Hardware Name
description:
type: string
example: description
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
category:
oneOf:
- $ref: '#/components/schemas/Category2'
- $ref: '#/components/schemas/Category21'
ip_address:
type: string
example: 0.0.0.0
external_ip:
type: string
example: 0.0.0.0
status:
oneOf:
- $ref: '#/components/schemas/Status'
- $ref: '#/components/schemas/Status1'
technical_contact:
oneOf:
- $ref: '#/components/schemas/TechnicalContact2'
- $ref: '#/components/schemas/TechnicalContact21'
owner:
oneOf:
- $ref: '#/components/schemas/Owner2'
- $ref: '#/components/schemas/Owner21'
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
format: int32
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
format: int32
example: 1
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
bio:
$ref: '#/components/schemas/Bio2'
tag:
type: string
example: hardware tag
asset_tag:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
MobilesResponse:
title: MobilesResponse
type: object
properties:
mobile:
$ref: '#/components/schemas/Mobile'
xml:
name: _
attribute: false
wrapped: false
Mobile:
title: Mobile
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Apple 1
description:
type: string
example: description
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
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
format: int32
example: 1
imei:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
user:
$ref: '#/components/schemas/User13'
technical_contact:
$ref: '#/components/schemas/TechnicalContact'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
User13:
title: User13
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
account_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
user_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
email:
type: string
example: john.doe@email.com
name:
type: string
example: John Doe
disabled:
type: boolean
example: false
avatar:
$ref: '#/components/schemas/Avatar'
MobilesRequest:
title: MobilesRequest
type: object
properties:
mobile:
$ref: '#/components/schemas/Mobile2'
xml:
name: _
attribute: false
wrapped: false
Mobile2:
title: Mobile2
type: object
properties:
description:
type: string
example: description
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
status:
oneOf:
- $ref: '#/components/schemas/Status'
- $ref: '#/components/schemas/Status1'
device_type:
type: string
example: Mobile Device
manufacturer:
type: string
example: Apple
model:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
company_issued:
type: boolean
example: true
serial_number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
imei:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
user:
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/User1'
technical_contact:
oneOf:
- $ref: '#/components/schemas/TechnicalContact2'
- $ref: '#/components/schemas/TechnicalContact21'
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
MobilesResponse4:
title: MobilesResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
MobilesRequest1:
title: MobilesRequest1
type: object
properties:
mobile:
$ref: '#/components/schemas/Mobile7'
xml:
name: _
attribute: false
wrapped: false
Mobile7:
title: Mobile7
required:
- manufacturer
- model
- serial_number
type: object
properties:
description:
type: string
example: description
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
status:
oneOf:
- $ref: '#/components/schemas/Status'
- $ref: '#/components/schemas/Status1'
device_type:
type: string
example: Mobile Device
manufacturer:
type: string
example: Apple
model:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
company_issued:
type: boolean
example: true
serial_number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
imei:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
user:
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/User1'
technical_contact:
oneOf:
- $ref: '#/components/schemas/TechnicalContact2'
- $ref: '#/components/schemas/TechnicalContact21'
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
OtherAssetsResponse:
title: OtherAssetsResponse
type: object
properties:
other_asset:
$ref: '#/components/schemas/OtherAsset'
xml:
name: _
attribute: false
wrapped: false
OtherAsset:
title: OtherAsset
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Apple 1
description:
type: string
example: description
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
status:
type: string
example: Operational
asset_type:
$ref: '#/components/schemas/AssetType'
asset_id:
type: string
example: '1'
manufacturer:
type: string
example: Apple
model:
type: string
example: '1'
ip:
type: string
example: 0.0.0.0
serial_number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
user:
$ref: '#/components/schemas/User24'
owner:
$ref: '#/components/schemas/Owner'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
AssetType:
title: AssetType
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
account_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
parent_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Asset Type
User24:
title: User24
type: object
properties:
group_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
is_user:
oneOf:
- type: string
example: 'true'
- type: boolean
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: John Doe
email:
type: string
example: john.doe@email.com
avatar:
$ref: '#/components/schemas/Avatar'
OtherAssetsRequest:
title: OtherAssetsRequest
type: object
properties:
other_asset:
$ref: '#/components/schemas/OtherAsset2'
xml:
name: _
attribute: false
wrapped: false
OtherAsset2:
title: OtherAsset2
type: object
properties:
name:
type: string
example: Asset Name
description:
type: string
example: description
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
asset_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
asset_type:
oneOf:
- $ref: '#/components/schemas/AssetType2'
- $ref: '#/components/schemas/AssetType21'
example:
name: Printer
status:
oneOf:
- $ref: '#/components/schemas/Status'
- $ref: '#/components/schemas/Status1'
example:
name: Operational
manufacturer:
type: string
example: Apple
ip_address:
type: string
example: 0.0.0.0
model:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
serial_number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
user:
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/User1'
owner:
oneOf:
- $ref: '#/components/schemas/Owner2'
- $ref: '#/components/schemas/Owner21'
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
AssetType2:
title: AssetType2
required:
- name
type: object
properties:
name:
type: string
example: Object Name
AssetType21:
title: AssetType21
enum:
- nil
type: string
OtherAssetsResponse4:
title: OtherAssetsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
OtherAssetsRequest1:
title: OtherAssetsRequest1
type: object
properties:
other_asset:
$ref: '#/components/schemas/OtherAsset7'
xml:
name: _
attribute: false
wrapped: false
OtherAsset7:
title: OtherAsset7
required:
- name
- asset_type
- manufacturer
type: object
properties:
name:
type: string
example: Asset Name
description:
type: string
example: description
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
asset_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
asset_type:
oneOf:
- $ref: '#/components/schemas/AssetType2'
- $ref: '#/components/schemas/AssetType21'
example:
name: Printer
status:
oneOf:
- $ref: '#/components/schemas/Status'
- $ref: '#/components/schemas/Status1'
example:
name: Operational
manufacturer:
type: string
example: Apple
ip_address:
type: string
example: 0.0.0.0
model:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
serial_number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
user:
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/User1'
owner:
oneOf:
- $ref: '#/components/schemas/Owner2'
- $ref: '#/components/schemas/Owner21'
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
SoftwaresResponse:
title: SoftwaresResponse
type: object
properties:
software:
$ref: '#/components/schemas/Software'
xml:
name: _
attribute: false
wrapped: false
Software:
title: Software
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
$ref: '#/components/schemas/Vendor'
installs:
type: integer
format: int32
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
Vendor:
title: Vendor
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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
description: support phone number
example: '+000000000'
business_phone:
type: string
description: business phone
example: '+000000000'
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
PrintersResponse:
title: PrintersResponse
type: object
properties:
printer:
$ref: '#/components/schemas/Printer'
xml:
name: _
attribute: false
wrapped: false
Printer:
title: Printer
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
technical_contact:
$ref: '#/components/schemas/TechnicalContact'
PrintersRequest:
title: PrintersRequest
type: object
properties:
printer:
$ref: '#/components/schemas/Printer2'
xml:
name: _
attribute: false
wrapped: false
Printer2:
title: Printer2
type: object
properties:
site_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
department_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
technical_contact:
oneOf:
- $ref: '#/components/schemas/TechnicalContact2'
- $ref: '#/components/schemas/TechnicalContact21'
address:
type: string
description: Building/Floor/Room
example: address description
ContractsResponse:
title: ContractsResponse
type: object
properties:
contract:
$ref: '#/components/schemas/Contract'
xml:
name: _
attribute: false
wrapped: false
Contract:
title: Contract
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
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:
$ref: '#/components/schemas/Tag'
description: ''
items:
type: array
items:
$ref: '#/components/schemas/Item'
description: ''
Item:
title: Item
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
ContractsRequest:
title: ContractsRequest
type: object
properties:
contract:
$ref: '#/components/schemas/Contract2'
xml:
name: _
attribute: false
wrapped: false
Contract2:
title: Contract2
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:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
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
ContractsResponse4:
title: ContractsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
ContractsRequest1:
title: ContractsRequest1
type: object
properties:
contract:
$ref: '#/components/schemas/Contract7'
xml:
name: _
attribute: false
wrapped: false
Contract7:
title: Contract7
required:
- manufacturer_name
- name
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:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
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
PurchaseOrdersResponse:
title: PurchaseOrdersResponse
type: object
properties:
purchase_order:
$ref: '#/components/schemas/PurchaseOrder8'
xml:
name: _
attribute: false
wrapped: false
PurchaseOrder8:
title: PurchaseOrder8
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
$ref: '#/components/schemas/Buyer'
site:
$ref: '#/components/schemas/Site133'
department:
$ref: '#/components/schemas/Department133'
state:
type: string
example: Approved
requester:
allOf:
- $ref: '#/components/schemas/Requester43'
- 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:
$ref: '#/components/schemas/Vendor4'
billing_address:
type: string
example: Billing address
shiping_address:
type: string
example: Shiping address
payment_terms:
type: string
example: Purchase terms
terms_conditions:
type: string
example: Terms conditions
custom_fields_values:
type: array
items:
$ref: '#/components/schemas/CustomFieldsValues1'
description: ''
purchase_order_items:
type: array
items:
$ref: '#/components/schemas/PurchaseOrderItem'
description: ''
Buyer:
title: Buyer
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Object Name
href:
type: string
example: /objects/1
Site133:
title: Site133
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Object Name
href:
type: string
example: /objects/1
Department133:
title: Department133
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Object Name
href:
type: string
example: /objects/1
Requester43:
title: Requester43
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Object Name
href:
type: string
example: /objects/1
example:
id: '1'
name: John Doe
href: /users/1
Vendor4:
title: Vendor4
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Object Name
href:
type: string
example: /objects/1
PurchaseOrderItem:
title: PurchaseOrderItem
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
PurchaseOrdersRequest:
title: PurchaseOrdersRequest
type: object
properties:
purchase_order:
$ref: '#/components/schemas/PurchaseOrder10'
xml:
name: _
attribute: false
wrapped: false
PurchaseOrder10:
title: PurchaseOrder10
type: object
properties:
name:
type: string
example: Purchase order Name
buyer_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
order_date:
type: string
example: Jan 01, 2025
due_date:
type: string
example: Jan 01, 2030
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
state:
type: string
example: Approved
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
recurrence:
type: string
example: Monthly
total_cost:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
currency:
type: string
example: USD
notes:
type: string
example: Purchase notes
vendor:
oneOf:
- $ref: '#/components/schemas/Vendor6'
- $ref: '#/components/schemas/Vendor61'
billing_address:
type: string
example: Billing address
shiping_address:
type: string
example: Shiping address
payment_terms:
type: string
example: Purchase terms
terms_conditions:
type: string
example: Terms conditions
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
approval_levels_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ApprovalLevelsAttribute'
- type: array
items:
$ref: '#/components/schemas/ApprovalLevelsAttribute'
Vendor6:
title: Vendor6
required:
- name
type: object
properties:
name:
type: string
example: Object Name
Vendor61:
title: Vendor61
enum:
- nil
type: string
PurchaseOrdersResponse4:
title: PurchaseOrdersResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
PurchaseOrdersRequest1:
title: PurchaseOrdersRequest1
type: object
properties:
purchase_order:
$ref: '#/components/schemas/PurchaseOrder15'
xml:
name: _
attribute: false
wrapped: false
PurchaseOrder15:
title: PurchaseOrder15
required:
- name
- vendor
type: object
properties:
name:
type: string
example: Purchase order Name
buyer_id:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
order_date:
type: string
example: Jan 01, 2025
due_date:
type: string
example: Jan 01, 2030
site:
oneOf:
- $ref: '#/components/schemas/Site10'
- $ref: '#/components/schemas/Site101'
department:
oneOf:
- $ref: '#/components/schemas/Department10'
- $ref: '#/components/schemas/Department101'
state:
type: string
example: Approved
requester:
oneOf:
- $ref: '#/components/schemas/Requester2'
- $ref: '#/components/schemas/Requester21'
recurrence:
type: string
example: Monthly
total_cost:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
currency:
type: string
example: USD
notes:
type: string
example: Purchase notes
vendor:
oneOf:
- $ref: '#/components/schemas/Vendor6'
- $ref: '#/components/schemas/Vendor61'
billing_address:
type: string
example: Billing address
shiping_address:
type: string
example: Shiping address
payment_terms:
type: string
example: Purchase terms
terms_conditions:
type: string
example: Terms conditions
custom_fields_values:
$ref: '#/components/schemas/CustomFieldsValues'
custom_fields_values_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
- type: array
items:
$ref: '#/components/schemas/CustomFieldsValuesAttribute'
approval_levels_attributes:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ApprovalLevelsAttribute'
- type: array
items:
$ref: '#/components/schemas/ApprovalLevelsAttribute'
VendorsResponse:
title: VendorsResponse
type: object
properties:
vendor:
$ref: '#/components/schemas/Vendor14'
xml:
name: _
attribute: false
wrapped: false
Vendor14:
title: Vendor14
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: SolarWinds
vendor_type:
$ref: '#/components/schemas/VendorType'
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'
VendorType:
title: VendorType
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: General Business Vendor
VendorsRequest:
title: VendorsRequest
type: object
properties:
vendor:
$ref: '#/components/schemas/Vendor16'
xml:
name: _
attribute: false
wrapped: false
Vendor16:
title: Vendor16
type: object
properties:
name:
type: string
example: SolarWinds
vendor_type:
oneOf:
- $ref: '#/components/schemas/VendorType2'
- $ref: '#/components/schemas/VendorType21'
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'
VendorType2:
title: VendorType2
required:
- name
type: object
properties:
name:
type: string
example: Object Name
VendorType21:
title: VendorType21
enum:
- nil
type: string
VendorsResponse4:
title: VendorsResponse4
required:
- deleted_ids
type: object
properties:
deleted_ids:
type: array
items:
type: string
description: ''
example:
deleted_ids:
- '1'
VendorsRequest1:
title: VendorsRequest1
type: object
properties:
vendor:
$ref: '#/components/schemas/Vendor21'
xml:
name: _
attribute: false
wrapped: false
Vendor21:
title: Vendor21
required:
- name
- vendor_type
type: object
properties:
name:
type: string
example: SolarWinds
vendor_type:
oneOf:
- $ref: '#/components/schemas/VendorType2'
- $ref: '#/components/schemas/VendorType21'
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'
ContractsItemsRequest:
title: ContractsItemsRequest
type: object
properties:
item:
$ref: '#/components/schemas/Item8'
xml:
name: _
attribute: false
wrapped: false
Item8:
title: Item8
required:
- name
type: object
properties:
name:
type: string
example: Item Name
version:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
qty:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
tag:
type: string
example: Item tag
ContractsItemsResponse:
title: ContractsItemsResponse
type: object
properties:
item:
$ref: '#/components/schemas/Item9'
xml:
name: _
attribute: false
wrapped: false
Item9:
title: Item9
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Item Name
version:
type: string
example: '1'
qty:
type: string
example: '1'
tag:
type: string
example: Item tag
ContractsItemsRequest1:
title: ContractsItemsRequest1
type: object
properties:
item:
$ref: '#/components/schemas/Item11'
xml:
name: _
attribute: false
wrapped: false
Item11:
title: Item11
type: object
properties:
name:
type: string
example: Item Name
version:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
qty:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
tag:
type: string
example: Item tag
ContractsItemsResponse4:
title: ContractsItemsResponse4
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted item
TasksRequest:
title: TasksRequest
type: object
properties:
task:
$ref: '#/components/schemas/Task'
xml:
name: _
attribute: false
wrapped: false
Task:
title: Task
required:
- name
type: object
properties:
name:
type: string
example: Task Name
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
due_at:
type: string
example: Jan 01, 2030
is_complete:
type: boolean
example: false
TasksResponse:
title: TasksResponse
type: object
properties:
task:
$ref: '#/components/schemas/Task1'
xml:
name: _
attribute: false
wrapped: false
Task1:
title: Task1
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Task Name
due_at:
type: string
example: 2030-01-01T00:00:00.000+01:00
requester:
$ref: '#/components/schemas/Requester'
assignee:
$ref: '#/components/schemas/Assignee'
parent:
$ref: '#/components/schemas/Parent3'
Parent3:
title: Parent3
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
class:
type: string
example: Incident
TasksTaskIdRequest:
title: TasksTaskIdRequest
type: object
properties:
task:
$ref: '#/components/schemas/Task3'
xml:
name: _
attribute: false
wrapped: false
Task3:
title: Task3
type: object
properties:
name:
type: string
example: Task Name
assignee:
oneOf:
- $ref: '#/components/schemas/Assignee2'
- $ref: '#/components/schemas/Assignee21'
due_at:
type: string
example: Jan 01, 2030
is_complete:
type: boolean
example: false
TasksTaskIdResponse:
title: TasksTaskIdResponse
type: object
properties:
task:
$ref: '#/components/schemas/Task1'
xml:
name: _
attribute: false
wrapped: false
TasksTaskIdResponse2:
title: TasksTaskIdResponse2
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted task
CommentsRequest:
title: CommentsRequest
type: object
properties:
comment:
$ref: '#/components/schemas/Comment'
xml:
name: _
attribute: false
wrapped: false
Comment:
title: Comment
required:
- body
type: object
properties:
body:
type: string
example: Comment body
is_private:
anyOf:
- type: string
example: 'true'
- type: boolean
example: true
CommentsResponse:
title: CommentsResponse
type: object
properties:
comment:
$ref: '#/components/schemas/Comment1'
xml:
name: _
attribute: false
wrapped: false
Comment1:
title: Comment1
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
$ref: '#/components/schemas/User13'
commenter_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
commenter_type:
type: string
example: Incident
CommentsCommentIdRequest:
title: CommentsCommentIdRequest
type: object
properties:
comment:
$ref: '#/components/schemas/Comment3'
xml:
name: _
attribute: false
wrapped: false
Comment3:
title: Comment3
type: object
properties:
body:
type: string
example: Comment body
is_private:
anyOf:
- type: string
example: 'true'
- type: boolean
example: true
CommentsCommentIdResponse:
title: CommentsCommentIdResponse
type: object
properties:
comment:
$ref: '#/components/schemas/Comment1'
xml:
name: _
attribute: false
wrapped: false
CommentsCommentIdResponse2:
title: CommentsCommentIdResponse2
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted comment
HardwaresWarrantiesResponse:
title: HardwaresWarrantiesResponse
type: object
properties:
warranty:
$ref: '#/components/schemas/Warranty'
xml:
name: _
attribute: false
wrapped: false
Warranty:
title: Warranty
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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
HardwaresWarrantiesRequest:
title: HardwaresWarrantiesRequest
type: object
properties:
warranty:
$ref: '#/components/schemas/Warranty2'
xml:
name: _
attribute: false
wrapped: false
Warranty2:
title: Warranty2
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
HardwaresWarrantiesResponse6:
title: HardwaresWarrantiesResponse6
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted warranty
TimeTracksResponse:
title: TimeTracksResponse
type: object
properties:
time_track:
$ref: '#/components/schemas/TimeTrack'
xml:
name: _
attribute: false
wrapped: false
TimeTrack:
title: TimeTrack
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
$ref: '#/components/schemas/Creator8'
parent:
$ref: '#/components/schemas/Parent3'
Creator8:
title: Creator8
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
account_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
user_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
email:
type: string
example: john.doe@email.com
name:
type: string
example: John Doe
disabled:
type: boolean
example: false
avatar:
$ref: '#/components/schemas/Avatar'
TimeTracksRequest:
title: TimeTracksRequest
type: object
properties:
time_track:
$ref: '#/components/schemas/TimeTrack2'
xml:
name: _
attribute: false
wrapped: false
TimeTrack2:
title: TimeTrack2
type: object
properties:
name:
type: string
example: Time Track Name
minutes_parsed:
type: string
example: 2h
TimeTracksTimeTrackIdRequest:
title: TimeTracksTimeTrackIdRequest
type: object
properties:
time_track:
$ref: '#/components/schemas/TimeTrack2'
xml:
name: _
attribute: false
wrapped: false
TimeTracksTimeTrackIdResponse:
title: TimeTracksTimeTrackIdResponse
type: object
properties:
time_track:
$ref: '#/components/schemas/TimeTrack'
xml:
name: _
attribute: false
wrapped: false
TimeTracksTimeTrackIdResponse2:
title: TimeTracksTimeTrackIdResponse2
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted time track
PurchasesRequest:
title: PurchasesRequest
type: object
properties:
purchase:
$ref: '#/components/schemas/Purchase'
xml:
name: _
attribute: false
wrapped: false
Purchase:
title: Purchase
type: object
properties:
number:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
date:
type: string
example: Jan 01, 2025
recurrence:
type: string
example: Monthly
total_cost:
anyOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
currency:
type: string
example: USD
notes:
type: string
example: Purchase notes
vendor:
oneOf:
- $ref: '#/components/schemas/Vendor6'
- $ref: '#/components/schemas/Vendor61'
PurchasesResponse:
title: PurchasesResponse
type: object
properties:
purchase:
$ref: '#/components/schemas/Purchase1'
xml:
name: _
attribute: false
wrapped: false
Purchase1:
title: Purchase1
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
$ref: '#/components/schemas/Vendor'
PurchasesPurchaseIdRequest:
title: PurchasesPurchaseIdRequest
type: object
properties:
purchase:
$ref: '#/components/schemas/Purchase'
xml:
name: _
attribute: false
wrapped: false
PurchasesPurchaseIdResponse:
title: PurchasesPurchaseIdResponse
type: object
properties:
purchase:
$ref: '#/components/schemas/Purchase1'
xml:
name: _
attribute: false
wrapped: false
PurchasesPurchaseIdResponse2:
title: PurchasesPurchaseIdResponse2
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted purchase
MembershipsResponse:
title: MembershipsResponse
required:
- messages
type: object
properties:
messages:
type: object
example:
messages:
message: Deleted membership
AuditsResponse:
title: AuditsResponse
type: object
properties:
audit:
$ref: '#/components/schemas/Audit'
xml:
name: _
attribute: false
wrapped: false
Audit:
title: Audit
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
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:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
user_id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
user:
$ref: '#/components/schemas/User13'
site:
$ref: '#/components/schemas/Site'
department:
$ref: '#/components/schemas/Department'
note:
type: string
example: Audit note
RisksResponse:
title: RisksResponse
type: object
properties:
id:
oneOf:
- type: string
example: 1
- type: integer
format: int32
readOnly: true
name:
type: string
severity:
type: string
category:
type: string
discarded:
type: boolean
resolved:
type: boolean
affected_assets:
$ref: '#/components/schemas/AffectedAssets'
created_at:
type: string
updated at:
type: string
xml:
name: _
attribute: false
wrapped: false
AffectedAssets:
title: AffectedAssets
type: object
properties:
id:
oneOf:
- type: string
example: '1'
- type: integer
format: int32
example: 1
readOnly: true
name:
type: string
example: Computer name
type:
type: string
example: Hardware
tags:
- name: Incident
description: Incident operations
- name: Problem
description: Problem operations
- name: Change
description: Change operations
- name: Change Catalog
description: Change catalog operations
- name: Release
description: Release operations
- name: Solution
description: Solution operations
- name: Catalog Item
description: Catalog Item operations
- name: Service Request
description: Requesting a service
- name: Configuration Item
description: Configuration Item operations
- name: User
description: User operations
- name: Site
description: Site operations
- name: Department
description: Department operations
- name: Role
description: Role operations
- name: Group
description: Group operations
- name: Membership
description: Membership operations
- name: Category
description: Category operations
- name: Hardware
description: Hardware operations
- name: Mobile Device
description: Mobile device operations
- name: Other Asset
description: Other asset operations
- name: Software
description: Software operations
- name: Printer
description: Printer operations
- name: Contract
description: Contract operations
- name: Purchase Order
description: Purchase order operations
- name: Vendor
description: Vendor operations
- name: Task
description: Task operations
- name: Comment
description: Comment operations
- name: Time Track
description: Time Track operations
- name: Purchase
description: Purchase operations
- name: Audit
description: Audit operations
- name: Risk
description: Risk operations
- name: Attachment
description: Attachment operations